author = 'Keith Busch <kbusch@kernel.org>'
master_doc = 'index'
-release = '1.8'
+release = '1.9'
# -- General configuration ---------------------------------------------------
"description": "Controller DH-HMAC-CHAP key",
"type": "string"
},
+ "keyring": {
+ "description": "Keyring for TLS key lookup",
+ "type": "string"
+ },
+ "tls_key": {
+ "description": "TLS key for the connection",
+ "type": "string"
+ },
"nr_io_queues": {
"description": "Number of I/O queues",
"type": "integer"
"type": "boolean",
"default": false
},
- "keyring": {
- "description": "Keyring for TLS key lookup",
- "type": "integer"
- },
- "tls_key": {
- "description": "TLS key for the connection",
- "type": "integer"
- },
"tls": {
"description": "Enable TLS encryption",
"type": "boolean",
-.TH "libnvme" 9 "struct nbft_control" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_control" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_control \- NBFT Table - Control Descriptor (Figure 8)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_control_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_control_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_control_flags \- Control Descriptor Flags
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_desc_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_desc_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_desc_type \- NBFT Elements - Descriptor Types (Figure 5)
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_discovery" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_discovery" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_discovery \- Discovery Descriptor (Figure 24)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_discovery_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_discovery_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_discovery_flags \- Discovery Descriptor Flags
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_header" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_header" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_header \- NBFT Table - Header (Figure 8)
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_heap_obj" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_heap_obj" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_heap_obj \- NBFT Header Driver Signature
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_hfi" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_hfi" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_hfi \- Host Fabric Interface (HFI) Descriptor (Figure 11)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_hfi_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_hfi_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_hfi_flags \- HFI Descriptor Flags
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_hfi_info_tcp" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_hfi_info_tcp" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP (Figure 13)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_hfi_info_tcp_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_hfi_info_tcp_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_hfi_info_tcp_flags \- HFI Transport Flags
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_host" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_host" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_host \- Host Descriptor (Figure 9)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_host_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_host_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_host_flags \- Host Flags
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_info" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_info" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info \- The parsed NBFT table data.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_info_discovery" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_info_discovery" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_discovery \- Discovery Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_info_hfi" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_info_hfi" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_hfi \- Host Fabric Interface (HFI) Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_info_hfi_info_tcp" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_hfi_info_tcp \- HFI Transport Info Descriptor - NVMe/TCP
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_info_host" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_info_host" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_host \- Host Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_info_nid_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_info_nid_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_info_nid_type \- Namespace Identifier Type (NIDT)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_info_primary_admin_host_flag" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_info_primary_admin_host_flag" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_info_primary_admin_host_flag \- Primary Administrative Host Descriptor Flags
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_info_security" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_info_security" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_security \- Security Profile Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_info_subsystem_ns" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_info_subsystem_ns" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_info_subsystem_ns \- Subsystem Namespace (SSNS) info
.SH SYNOPSIS
.br
.BI " char *dhcp_root_path_string;"
.br
+.BI " bool discovered;"
+.br
+.BI " bool unavailable;"
+.br
.BI "
};
.br
.IP "dhcp_root_path_string" 12
DHCP Root Path Override string (SSNS Extended
Information Descriptor).
+.IP "discovered" 12
+Indicates that this namespace was acquired
+through discovery.
+.IP "unavailable" 12
+Namespace is unavailable as indicated by
+the pre-OS driver.
-.TH "libnvme" 9 "struct nbft_security" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_security" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_security \- Security Profile Descriptor (Figure 21)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_security_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_security_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_security_flags \- Security Profile Descriptor Flags (Figure 22)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_security_secret_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_security_secret_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_security_secret_type \- Security Profile Descriptor Secret Type
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_ssns" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_ssns" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_ssns \- Subsystem Namespace (SSNS) Descriptor (Figure 15)
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nbft_ssns_ext_info" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nbft_ssns_ext_info" "May 2024" "API Manual" LINUX
.SH NAME
struct nbft_ssns_ext_info \- Subsystem and Namespace Extended Information Descriptor (Figure 19)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_ssns_ext_info_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_ssns_ext_info_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_ssns_ext_info_flags \- Subsystem and Namespace Extended Information Descriptor Flags
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_ssns_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_ssns_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_ssns_flags \- Subsystem and Namespace Specific Flags Field (Figure 16)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_ssns_trflags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_ssns_trflags" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_ssns_trflags \- SSNS Transport Specific Flags Field (Figure 17)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nbft_trtype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nbft_trtype" "May 2024" "API Manual" LINUX
.SH NAME
enum nbft_trtype \- NBFT Interface Transport Types (Figure 7)
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_acq" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_acq \- This field indicates the admin completion queue base address
+.SH SYNOPSIS
+enum nvme_acq {
+.br
+.BI " NVME_ACQ_ACQB_SHIFT"
+
+};
+.SH Constants
+.IP "NVME_ACQ_ACQB_SHIFT" 12
+Shift amount to get the admin completion queue base
-.TH "libnvme" 9 "enum nvme_admin_opcode" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_admin_opcode" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_admin_opcode \- Known NVMe admin opcodes
.SH SYNOPSIS
-.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_admin_passthru \- Submit an nvme passthrough command
.SH SYNOPSIS
-.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_admin_passthru64 \- Submit a 64-bit nvme passthrough command
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ae_info_error" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_error" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ae_info_notice" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_notice" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ae_info_smart" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_smart" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ae_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ae_type \- Asynchronous Event Type
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_aggregate_endurance_group_event \- Endurance Group Event Aggregate
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_aggregate_predictable_lat_event \- Predictable Latency Event Aggregate Log Page
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_ana_group_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ana_group_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_ana_group_desc \- ANA Group Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_ana_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ana_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_ana_log \- Asymmetric Namespace Access Log
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ana_state" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ana_state" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ana_state \- ANA Group Descriptor - Asymmetric Namespace Access State
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_apst_entry" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_apst_entry" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_apst_entry \- Autonomous Power State Transition
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_aqa" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_aqa \- This field indicates the admin queue attributes
+.SH SYNOPSIS
+enum nvme_aqa {
+.br
+.BI " NVME_AQA_ASQS_SHIFT"
+,
+.br
+.br
+.BI " NVME_AQA_ACQS_SHIFT"
+,
+.br
+.br
+.BI " NVME_AQA_ASQS_MASK"
+,
+.br
+.br
+.BI " NVME_AQA_ACQS_MASK"
+
+};
+.SH Constants
+.IP "NVME_AQA_ASQS_SHIFT" 12
+Shift amount to get the admin submission queue size
+.IP "NVME_AQA_ACQS_SHIFT" 12
+Shift amount to get the admin completion queue size
+.IP "NVME_AQA_ASQS_MASK" 12
+Mask to get the admin submission queue size
+.IP "NVME_AQA_ACQS_MASK" 12
+Mask to get the admin completion queue size
--- /dev/null
+.TH "libnvme" 9 "enum nvme_asq" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_asq \- This field indicates the admin submission queue base address
+.SH SYNOPSIS
+enum nvme_asq {
+.br
+.BI " NVME_ASQ_ASQB_SHIFT"
+
+};
+.SH Constants
+.IP "NVME_ASQ_ASQB_SHIFT" 12
+Shift amount to get the admin submission queue base
-.TH "libnvme" 9 "struct nvme_boot_partition" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_boot_partition" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_boot_partition \- Boot Partition Log
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_boot_partition_info" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_boot_partition_info \- This field indicates the boot partition information
+.SH SYNOPSIS
+enum nvme_boot_partition_info {
+.br
+.BI " NVME_BOOT_PARTITION_INFO_BPSZ_SHIFT"
+,
+.br
+.br
+.BI " NVME_BOOT_PARTITION_INFO_ABPID_SHIFT"
+,
+.br
+.br
+.BI " NVME_BOOT_PARTITION_INFO_BPSZ_MASK"
+,
+.br
+.br
+.BI " NVME_BOOT_PARTITION_INFO_ABPID_MASK"
+
+};
+.SH Constants
+.IP "NVME_BOOT_PARTITION_INFO_BPSZ_SHIFT" 12
+Shift amount to get the boot partition size from
+the \fIstruct nvme_boot_partition\fP.bpinfo field.
+.IP "NVME_BOOT_PARTITION_INFO_ABPID_SHIFT" 12
+Shift amount to get the active boot partition ID
+from the \fIstruct nvme_boot_partition\fP.bpinfo field.
+.IP "NVME_BOOT_PARTITION_INFO_BPSZ_MASK" 12
+Mask to get the boot partition size from the
+\fIstruct nvme_boot_partition\fP.bpinfo field.
+.IP "NVME_BOOT_PARTITION_INFO_ABPID_MASK" 12
+Mask to get the active boot partition ID from the
+\fIstruct nvme_boot_partition\fP.bpinfo field.
--- /dev/null
+.TH "libnvme" 9 "enum nvme_bpinfo" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_bpinfo \- This field indicates the boot partition information
+.SH SYNOPSIS
+enum nvme_bpinfo {
+.br
+.BI " NVME_BPINFO_BPSZ_SHIFT"
+,
+.br
+.br
+.BI " NVME_BPINFO_BRS_SHIFT"
+,
+.br
+.br
+.BI " NVME_BPINFO_ABPID_SHIFT"
+,
+.br
+.br
+.BI " NVME_BPINFO_BPSZ_MASK"
+,
+.br
+.br
+.BI " NVME_BPINFO_BRS_MASK"
+,
+.br
+.br
+.BI " NVME_BPINFO_ABPID_MASK"
+,
+.br
+.br
+.BI " NVME_BPINFO_BRS_NONE"
+,
+.br
+.br
+.BI " NVME_BPINFO_BRS_READ_IN_PROGRESS"
+,
+.br
+.br
+.BI " NVME_BPINFO_BRS_READ_SUCCESS"
+,
+.br
+.br
+.BI " NVME_BPINFO_BRS_READ_ERROR"
+
+};
+.SH Constants
+.IP "NVME_BPINFO_BPSZ_SHIFT" 12
+Shift amount to get the boot partition size
+.IP "NVME_BPINFO_BRS_SHIFT" 12
+Shift amount to get the boot read status
+.IP "NVME_BPINFO_ABPID_SHIFT" 12
+Shift amount to get the active boot partition ID
+.IP "NVME_BPINFO_BPSZ_MASK" 12
+Mask to get the boot partition size
+.IP "NVME_BPINFO_BRS_MASK" 12
+Mask to get the boot read status
+.IP "NVME_BPINFO_ABPID_MASK" 12
+Mask to get the active boot partition ID
+.IP "NVME_BPINFO_BRS_NONE" 12
+No boot partition read operation requested
+.IP "NVME_BPINFO_BRS_READ_IN_PROGRESS" 12
+Boot partition read in progress
+.IP "NVME_BPINFO_BRS_READ_SUCCESS" 12
+Boot partition read completed successfully
+.IP "NVME_BPINFO_BRS_READ_ERROR" 12
+Error completing boot partition read
--- /dev/null
+.TH "libnvme" 9 "enum nvme_bpmbl" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_bpmbl \- This field indicates the boot partition memory buffer location
+.SH SYNOPSIS
+enum nvme_bpmbl {
+.br
+.BI " NVME_BPMBL_BMBBA_SHIFT"
+
+};
+.SH Constants
+.IP "NVME_BPMBL_BMBBA_SHIFT" 12
+Shift amount to get the boot partition memory buffer base address
--- /dev/null
+.TH "libnvme" 9 "enum nvme_bprsel" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_bprsel \- This field indicates the boot partition read select
+.SH SYNOPSIS
+enum nvme_bprsel {
+.br
+.BI " NVME_BPRSEL_BPRSZ_SHIFT"
+,
+.br
+.br
+.BI " NVME_BPRSEL_BPROF_SHIFT"
+,
+.br
+.br
+.BI " NVME_BPRSEL_BPID_SHIFT"
+,
+.br
+.br
+.BI " NVME_BPRSEL_BPRSZ_MASK"
+,
+.br
+.br
+.BI " NVME_BPRSEL_BPROF_MASK"
+,
+.br
+.br
+.BI " NVME_BPRSEL_BPID_MASK"
+
+};
+.SH Constants
+.IP "NVME_BPRSEL_BPRSZ_SHIFT" 12
+Shift amount to get the boot partition read size
+.IP "NVME_BPRSEL_BPROF_SHIFT" 12
+Shift amount to get the boot partition read offset
+.IP "NVME_BPRSEL_BPID_SHIFT" 12
+Shift amount to get the boot partition identifier
+.IP "NVME_BPRSEL_BPRSZ_MASK" 12
+Mask to get the boot partition read size
+.IP "NVME_BPRSEL_BPROF_MASK" 12
+Mask to get the boot partition read offset
+.IP "NVME_BPRSEL_BPID_MASK" 12
+Mask to get the boot partition identifier
--- /dev/null
+.TH "libnvme" 9 "enum nvme_cap" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_cap \- This field indicates the controller capabilities register
+.SH SYNOPSIS
+enum nvme_cap {
+.br
+.BI " NVME_CAP_MQES_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_CQR_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_AMS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_TO_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_DSTRD_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_NSSRC_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_CSS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_BPS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_CPS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_MPSMIN_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_MPSMAX_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_PMRS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_CMBS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_NSSS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_CRMS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CAP_MQES_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_CQR_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_AMS_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_TO_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_DSTRD_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_NSSRC_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_CSS_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_BPS_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_CPS_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_MPSMIN_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_MPSMAX_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_PMRS_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_CMBS_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_NSSS_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_CRMS_MASK"
+,
+.br
+.br
+.BI " NVME_CAP_AMS_WRR"
+,
+.br
+.br
+.BI " NVME_CAP_AMS_VS"
+,
+.br
+.br
+.BI " NVME_CAP_CSS_NVM"
+,
+.br
+.br
+.BI " NVME_CAP_CSS_CSI"
+,
+.br
+.br
+.BI " NVME_CAP_CSS_ADMIN"
+,
+.br
+.br
+.BI " NVME_CAP_CPS_NONE"
+,
+.br
+.br
+.BI " NVME_CAP_CPS_CTRL"
+,
+.br
+.br
+.BI " NVME_CAP_CPS_DOMAIN"
+,
+.br
+.br
+.BI " NVME_CAP_CPS_NVMS"
+,
+.br
+.br
+.BI " NVME_CAP_CRWMS"
+,
+.br
+.br
+.BI " NVME_CAP_CRIMS"
+
+};
+.SH Constants
+.IP "NVME_CAP_MQES_SHIFT" 12
+Shift amount to get the maximum queue entries supported
+.IP "NVME_CAP_CQR_SHIFT" 12
+Shift amount to get the contiguous queues required
+.IP "NVME_CAP_AMS_SHIFT" 12
+Shift amount to get the arbitration mechanism supported
+.IP "NVME_CAP_TO_SHIFT" 12
+Shift amount to get the timeout
+.IP "NVME_CAP_DSTRD_SHIFT" 12
+Shift amount to get the doorbell stride
+.IP "NVME_CAP_NSSRC_SHIFT" 12
+Shift amount to get the NVM subsystem reset supported
+.IP "NVME_CAP_CSS_SHIFT" 12
+Shift amount to get the command sets supported
+.IP "NVME_CAP_BPS_SHIFT" 12
+Shift amount to get the boot partition support
+.IP "NVME_CAP_CPS_SHIFT" 12
+Shift amount to get the controller power scope
+.IP "NVME_CAP_MPSMIN_SHIFT" 12
+Shift amount to get the memory page size minimum
+.IP "NVME_CAP_MPSMAX_SHIFT" 12
+Shift amount to get the memory page size maximum
+.IP "NVME_CAP_PMRS_SHIFT" 12
+Shift amount to get the persistent memory region supported
+.IP "NVME_CAP_CMBS_SHIFT" 12
+Shift amount to get the controller memory buffer supported
+.IP "NVME_CAP_NSSS_SHIFT" 12
+Shift amount to get the NVM subsystem shutdown supported
+.IP "NVME_CAP_CRMS_SHIFT" 12
+Shift amount to get the controller ready modes supported
+.IP "NVME_CAP_MQES_MASK" 12
+Mask to get the maximum queue entries supported
+.IP "NVME_CAP_CQR_MASK" 12
+Mask to get the contiguous queues required
+.IP "NVME_CAP_AMS_MASK" 12
+Mask to get the arbitration mechanism supported
+.IP "NVME_CAP_TO_MASK" 12
+Mask to get the timeout
+.IP "NVME_CAP_DSTRD_MASK" 12
+Mask to get the doorbell stride
+.IP "NVME_CAP_NSSRC_MASK" 12
+Mask to get the NVM subsystem reset supported
+.IP "NVME_CAP_CSS_MASK" 12
+Mask to get the command sets supported
+.IP "NVME_CAP_BPS_MASK" 12
+Mask to get the boot partition support
+.IP "NVME_CAP_CPS_MASK" 12
+Mask to get the controller power scope
+.IP "NVME_CAP_MPSMIN_MASK" 12
+Mask to get the memory page size minimum
+.IP "NVME_CAP_MPSMAX_MASK" 12
+Mask to get the memory page size maximum
+.IP "NVME_CAP_PMRS_MASK" 12
+Mask to get the persistent memory region supported
+.IP "NVME_CAP_CMBS_MASK" 12
+Mask to get the controller memory buffer supported
+.IP "NVME_CAP_NSSS_MASK" 12
+Mask to get the NVM subsystem shutdown supported
+.IP "NVME_CAP_CRMS_MASK" 12
+Mask to get the controller ready modes supported
+.IP "NVME_CAP_AMS_WRR" 12
+Weighted round robin with urgent priority class
+.IP "NVME_CAP_AMS_VS" 12
+Vendor specific
+.IP "NVME_CAP_CSS_NVM" 12
+NVM command set or a discovery controller
+.IP "NVME_CAP_CSS_CSI" 12
+Controller supports one or more I/O command sets
+.IP "NVME_CAP_CSS_ADMIN" 12
+No I/O command set is supported
+.IP "NVME_CAP_CPS_NONE" 12
+Not reported
+.IP "NVME_CAP_CPS_CTRL" 12
+Controller scope
+.IP "NVME_CAP_CPS_DOMAIN" 12
+Domain scope
+.IP "NVME_CAP_CPS_NVMS" 12
+NVM subsystem scope
+.IP "NVME_CAP_CRWMS" 12
+Controller ready with media support
+.IP "NVME_CAP_CRIMS" 12
+Controller ready independent of media support
-.TH "libnvme" 9 "struct nvme_capacity_config_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_capacity_config_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_capacity_config_desc \- Capacity Configuration structure definitions
.SH SYNOPSIS
-.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_capacity_mgmt \- Capacity management command
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_cc" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_cc \- This field indicates the controller configuration
+.SH SYNOPSIS
+enum nvme_cc {
+.br
+.BI " NVME_CC_EN_SHIFT"
+,
+.br
+.br
+.BI " NVME_CC_CSS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CC_MPS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CC_AMS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CC_SHN_SHIFT"
+,
+.br
+.br
+.BI " NVME_CC_IOSQES_SHIFT"
+,
+.br
+.br
+.BI " NVME_CC_IOCQES_SHIFT"
+,
+.br
+.br
+.BI " NVME_CC_CRIME_SHIFT"
+,
+.br
+.br
+.BI " NVME_CC_EN_MASK"
+,
+.br
+.br
+.BI " NVME_CC_CSS_MASK"
+,
+.br
+.br
+.BI " NVME_CC_MPS_MASK"
+,
+.br
+.br
+.BI " NVME_CC_AMS_MASK"
+,
+.br
+.br
+.BI " NVME_CC_SHN_MASK"
+,
+.br
+.br
+.BI " NVME_CC_CRIME_MASK"
+,
+.br
+.br
+.BI " NVME_CC_IOSQES_MASK"
+,
+.br
+.br
+.BI " NVME_CC_IOCQES_MASK"
+,
+.br
+.br
+.BI " NVME_CC_CSS_NVM"
+,
+.br
+.br
+.BI " NVME_CC_CSS_CSI"
+,
+.br
+.br
+.BI " NVME_CC_CSS_ADMIN"
+,
+.br
+.br
+.BI " NVME_CC_AMS_RR"
+,
+.br
+.br
+.BI " NVME_CC_AMS_WRRU"
+,
+.br
+.br
+.BI " NVME_CC_AMS_VS"
+,
+.br
+.br
+.BI " NVME_CC_SHN_NONE"
+,
+.br
+.br
+.BI " NVME_CC_SHN_NORMAL"
+,
+.br
+.br
+.BI " NVME_CC_SHN_ABRUPT"
+,
+.br
+.br
+.BI " NVME_CC_CRWME"
+,
+.br
+.br
+.BI " NVME_CC_CRIME"
+
+};
+.SH Constants
+.IP "NVME_CC_EN_SHIFT" 12
+Shift amount to get the enable
+.IP "NVME_CC_CSS_SHIFT" 12
+Shift amount to get the I/O command set selected
+.IP "NVME_CC_MPS_SHIFT" 12
+Shift amount to get the memory page size
+.IP "NVME_CC_AMS_SHIFT" 12
+Shift amount to get the arbitration mechanism selected
+.IP "NVME_CC_SHN_SHIFT" 12
+Shift amount to get the shutdown notification
+.IP "NVME_CC_IOSQES_SHIFT" 12
+Shift amount to get the I/O submission queue entry size
+.IP "NVME_CC_IOCQES_SHIFT" 12
+Shift amount to get the I/O completion queue entry size
+.IP "NVME_CC_CRIME_SHIFT" 12
+Shift amount to get the controller ready independent of media enable
+.IP "NVME_CC_EN_MASK" 12
+Mask to get the enable
+.IP "NVME_CC_CSS_MASK" 12
+Mask to get the I/O command set selected
+.IP "NVME_CC_MPS_MASK" 12
+Mask to get the memory page size
+.IP "NVME_CC_AMS_MASK" 12
+Mask to get the arbitration mechanism selected
+.IP "NVME_CC_SHN_MASK" 12
+Mask to get the shutdown notification
+.IP "NVME_CC_CRIME_MASK" 12
+Mask to get the I/O submission queue entry size
+.IP "NVME_CC_IOSQES_MASK" 12
+Mask to get the I/O completion queue entry size
+.IP "NVME_CC_IOCQES_MASK" 12
+Mask to get the controller ready independent of media enable
+.IP "NVME_CC_CSS_NVM" 12
+NVM command set
+.IP "NVME_CC_CSS_CSI" 12
+All supported I/O command sets
+.IP "NVME_CC_CSS_ADMIN" 12
+Admin command set only
+.IP "NVME_CC_AMS_RR" 12
+Round robin
+.IP "NVME_CC_AMS_WRRU" 12
+Weighted round robin with urgent priority class
+.IP "NVME_CC_AMS_VS" 12
+Vendor specific
+.IP "NVME_CC_SHN_NONE" 12
+No notification; no effect
+.IP "NVME_CC_SHN_NORMAL" 12
+Normal shutdown notification
+.IP "NVME_CC_SHN_ABRUPT" 12
+Abrupt shutdown notification
+.IP "NVME_CC_CRWME" 12
+Controller ready with media enable
+.IP "NVME_CC_CRIME" 12
+Controller ready independent of media enable
-.TH "libnvme" 9 "struct nvme_change_ns_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_change_ns_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_change_ns_event \- Change Namespace Event Data
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_channel_config_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_channel_config_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_channel_config_desc \- Channel Configuration Descriptor
.SH SYNOPSIS
-.TH "nvme_cmb_size" 9 "nvme_cmb_size" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_cmb_size" 9 "nvme_cmb_size" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_cmb_size \- Calculate size of the controller memory buffer
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_cmbebs" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_cmbebs \- This field indicates the controller memory buffer elasticity buffer size
+.SH SYNOPSIS
+enum nvme_cmbebs {
+.br
+.BI " NVME_CMBEBS_CMBSZU_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBEBS_RBB_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBEBS_CMBWBZ_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBEBS_CMBSZU_MASK"
+,
+.br
+.br
+.BI " NVME_CMBEBS_RBB_MASK"
+,
+.br
+.br
+.BI " NVME_CMBEBS_CMBWBZ_MASK"
+,
+.br
+.br
+.BI " NVME_CMBEBS_CMBSZU_B"
+,
+.br
+.br
+.BI " NVME_CMBEBS_CMBSZU_1K"
+,
+.br
+.br
+.BI " NVME_CMBEBS_CMBSZU_1M"
+,
+.br
+.br
+.BI " NVME_CMBEBS_CMBSZU_1G"
+
+};
+.SH Constants
+.IP "NVME_CMBEBS_CMBSZU_SHIFT" 12
+Shift amount to get the CMB elasticity buffer size units
+.IP "NVME_CMBEBS_RBB_SHIFT" 12
+Shift amount to get the read bypass behavior
+.IP "NVME_CMBEBS_CMBWBZ_SHIFT" 12
+Shift amount to get the CMB elasiticity buffer size base
+.IP "NVME_CMBEBS_CMBSZU_MASK" 12
+Mask to get the CMB elasticity buffer size units
+.IP "NVME_CMBEBS_RBB_MASK" 12
+Mask to get the read bypass behavior
+.IP "NVME_CMBEBS_CMBWBZ_MASK" 12
+Mask to get the CMB elasiticity buffer size base
+.IP "NVME_CMBEBS_CMBSZU_B" 12
+Bytes granularity
+.IP "NVME_CMBEBS_CMBSZU_1K" 12
+1 KiB granularity
+.IP "NVME_CMBEBS_CMBSZU_1M" 12
+1 MiB granularity
+.IP "NVME_CMBEBS_CMBSZU_1G" 12
+1 GiB granularity
--- /dev/null
+.TH "libnvme" 9 "enum nvme_cmbloc" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_cmbloc \- This field indicates the controller memory buffer location
+.SH SYNOPSIS
+enum nvme_cmbloc {
+.br
+.BI " NVME_CMBLOC_BIR_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CQMMS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CQPDS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CDPLMS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CDPCILS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CDMMMS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CQDA_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBLOC_OFST_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBLOC_BIR_MASK"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CQMMS_MASK"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CQPDS_MASK"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CDPLMS_MASK"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CDPCILS_MASK"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CDMMMS_MASK"
+,
+.br
+.br
+.BI " NVME_CMBLOC_CQDA_MASK"
+,
+.br
+.br
+.BI " NVME_CMBLOC_OFST_MASK"
+
+};
+.SH Constants
+.IP "NVME_CMBLOC_BIR_SHIFT" 12
+Shift amount to get the base indicator register
+.IP "NVME_CMBLOC_CQMMS_SHIFT" 12
+Shift amount to get the CMB queue mixed memory support
+.IP "NVME_CMBLOC_CQPDS_SHIFT" 12
+Shift amount to get the CMB queue physically discontiguous support
+.IP "NVME_CMBLOC_CDPLMS_SHIFT" 12
+Shift amount to get the CMB data pointer mixed locations support
+.IP "NVME_CMBLOC_CDPCILS_SHIFT" 12
+Shift amount to get the CMB data pointer and command independent locations support
+.IP "NVME_CMBLOC_CDMMMS_SHIFT" 12
+Shift amount to get the CMB data metadata mixed memory support
+.IP "NVME_CMBLOC_CQDA_SHIFT" 12
+Shift amount to get the CMB queue dword alignment
+.IP "NVME_CMBLOC_OFST_SHIFT" 12
+Shift amount to get the offset
+.IP "NVME_CMBLOC_BIR_MASK" 12
+Mask to get the base indicator register
+.IP "NVME_CMBLOC_CQMMS_MASK" 12
+Mask to get the CMB queue mixed memory support
+.IP "NVME_CMBLOC_CQPDS_MASK" 12
+Mask to get the CMB queue physically discontiguous support
+.IP "NVME_CMBLOC_CDPLMS_MASK" 12
+Mask to get the CMB data pointer mixed locations support
+.IP "NVME_CMBLOC_CDPCILS_MASK" 12
+Mask to get the CMB data pointer and command independent locations support
+.IP "NVME_CMBLOC_CDMMMS_MASK" 12
+Mask to get the CMB data metadata mixed memory support
+.IP "NVME_CMBLOC_CQDA_MASK" 12
+Mask to get the CMB queue dword alignment
+.IP "NVME_CMBLOC_OFST_MASK" 12
+Mask to get the offset
--- /dev/null
+.TH "libnvme" 9 "enum nvme_cmbmsc" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_cmbmsc \- This field indicates the controller memory buffer memory space control
+.SH SYNOPSIS
+enum nvme_cmbmsc {
+.br
+.BI " NVME_CMBMSC_CRE_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBMSC_CMSE_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBMSC_CBA_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBMSC_CRE_MASK"
+,
+.br
+.br
+.BI " NVME_CMBMSC_CMSE_MASK"
+
+};
+.SH Constants
+.IP "NVME_CMBMSC_CRE_SHIFT" 12
+Shift amount to get the capabilities registers enabled
+.IP "NVME_CMBMSC_CMSE_SHIFT" 12
+Shift amount to get the controller memory space enable
+.IP "NVME_CMBMSC_CBA_SHIFT" 12
+Shift amount to get the controller base address
+.IP "NVME_CMBMSC_CRE_MASK" 12
+Mask to get the capabilities registers enabled
+.IP "NVME_CMBMSC_CMSE_MASK" 12
+Mask to get the controller memory space enable
--- /dev/null
+.TH "libnvme" 9 "enum nvme_cmbsts" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_cmbsts \- This field indicates the controller memory buffer status
+.SH SYNOPSIS
+enum nvme_cmbsts {
+.br
+.BI " NVME_CMBSTS_CBAI_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBSTS_CBAI_MASK"
+
+};
+.SH Constants
+.IP "NVME_CMBSTS_CBAI_SHIFT" 12
+Shift amount to get the controller base address invalid
+.IP "NVME_CMBSTS_CBAI_MASK" 12
+Mask to get the controller base address invalid
--- /dev/null
+.TH "libnvme" 9 "enum nvme_cmbswtp" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_cmbswtp \- This field indicates the controller memory buffer sustained write throughput
+.SH SYNOPSIS
+enum nvme_cmbswtp {
+.br
+.BI " NVME_CMBSWTP_CMBSWTU_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBSWTP_CMBSWTV_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBSWTP_CMBSWTU_MASK"
+,
+.br
+.br
+.BI " NVME_CMBSWTP_CMBSWTV_MASK"
+,
+.br
+.br
+.BI " NVME_CMBSWTP_CMBSWTU_B"
+,
+.br
+.br
+.BI " NVME_CMBSWTP_CMBSWTU_1K"
+,
+.br
+.br
+.BI " NVME_CMBSWTP_CMBSWTU_1M"
+,
+.br
+.br
+.BI " NVME_CMBSWTP_CMBSWTU_1G"
+
+};
+.SH Constants
+.IP "NVME_CMBSWTP_CMBSWTU_SHIFT" 12
+Shift amount to get the CMB sustained write throughput units
+.IP "NVME_CMBSWTP_CMBSWTV_SHIFT" 12
+Shift amount to get the CMB sustained write throughput
+.IP "NVME_CMBSWTP_CMBSWTU_MASK" 12
+Mask to get the CMB sustained write throughput units
+.IP "NVME_CMBSWTP_CMBSWTV_MASK" 12
+Mask to get the CMB sustained write throughput
+.IP "NVME_CMBSWTP_CMBSWTU_B" 12
+Bytes/second granularity
+.IP "NVME_CMBSWTP_CMBSWTU_1K" 12
+1 KiB/second granularity
+.IP "NVME_CMBSWTP_CMBSWTU_1M" 12
+1 MiB/second granularity
+.IP "NVME_CMBSWTP_CMBSWTU_1G" 12
+1 GiB/second granularity
--- /dev/null
+.TH "libnvme" 9 "enum nvme_cmbsz" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_cmbsz \- This field indicates the controller memory buffer size
+.SH SYNOPSIS
+enum nvme_cmbsz {
+.br
+.BI " NVME_CMBSZ_SQS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBSZ_CQS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBSZ_LISTS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBSZ_RDS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBSZ_WDS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZU_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZ_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SQS_MASK"
+,
+.br
+.br
+.BI " NVME_CMBSZ_CQS_MASK"
+,
+.br
+.br
+.BI " NVME_CMBSZ_LISTS_MASK"
+,
+.br
+.br
+.BI " NVME_CMBSZ_RDS_MASK"
+,
+.br
+.br
+.BI " NVME_CMBSZ_WDS_MASK"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZU_MASK"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZ_MASK"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZU_4K"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZU_64K"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZU_1M"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZU_16M"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZU_256M"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZU_4G"
+,
+.br
+.br
+.BI " NVME_CMBSZ_SZU_64G"
+
+};
+.SH Constants
+.IP "NVME_CMBSZ_SQS_SHIFT" 12
+Shift amount to get the submission queue support
+.IP "NVME_CMBSZ_CQS_SHIFT" 12
+Shift amount to get the completion queue support
+.IP "NVME_CMBSZ_LISTS_SHIFT" 12
+Shift amount to get the PLP SGL list support
+.IP "NVME_CMBSZ_RDS_SHIFT" 12
+Shift amount to get the read data support
+.IP "NVME_CMBSZ_WDS_SHIFT" 12
+Shift amount to get the write data support
+.IP "NVME_CMBSZ_SZU_SHIFT" 12
+Shift amount to get the size units
+.IP "NVME_CMBSZ_SZ_SHIFT" 12
+Shift amount to get the size
+.IP "NVME_CMBSZ_SQS_MASK" 12
+Mask to get the submission queue support
+.IP "NVME_CMBSZ_CQS_MASK" 12
+Mask to get the completion queue support
+.IP "NVME_CMBSZ_LISTS_MASK" 12
+Mask to get the PLP SGL list support
+.IP "NVME_CMBSZ_RDS_MASK" 12
+Mask to get the read data support
+.IP "NVME_CMBSZ_WDS_MASK" 12
+Mask to get the write data support
+.IP "NVME_CMBSZ_SZU_MASK" 12
+Mask to get the size units
+.IP "NVME_CMBSZ_SZ_MASK" 12
+Mask to get the size
+.IP "NVME_CMBSZ_SZU_4K" 12
+4 KiB
+.IP "NVME_CMBSZ_SZU_64K" 12
+64 KiB
+.IP "NVME_CMBSZ_SZU_1M" 12
+1 MiB
+.IP "NVME_CMBSZ_SZU_16M" 12
+16 MiB
+.IP "NVME_CMBSZ_SZU_256M" 12
+256 MiB
+.IP "NVME_CMBSZ_SZU_4G" 12
+4 GiB
+.IP "NVME_CMBSZ_SZU_64G" 12
+64 GiB
-.TH "libnvme" 9 "enum nvme_cmd_effects" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_effects" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_cmd_effects \- Commands Supported and Effects
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_cmd_effects_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_cmd_effects_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_cmd_effects_log \- Commands Supported and Effects Log
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_cmd_format_mset" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_format_mset" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_mset \- Format NVM - Metadata Settings
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_cmd_format_pi" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_format_pi" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_pi \- Format NVM - Protection Information
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_cmd_format_pil" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_format_pil" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_pil \- Format NVM - Protection Information Location
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_cmd_format_ses" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_format_ses" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_ses \- Format NVM - Secure Erase Settings
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_cmd_get_log_lid \- Get Log Page -Log Page Identifiers
.SH SYNOPSIS
,
.br
.br
+.BI " NVME_LOG_LID_CMD_AND_FEAT_LOCKDOWN"
+,
+.br
+.br
.BI " NVME_LOG_LID_BOOT_PARTITION"
,
.br
Feature Identifiers Supported and Effects
.IP "NVME_LOG_LID_MI_CMD_SUPPORTED_EFFECTS" 12
NVMe-MI Commands Supported and Effects
+.IP "NVME_LOG_LID_CMD_AND_FEAT_LOCKDOWN" 12
+Command and Feature Lockdown
.IP "NVME_LOG_LID_BOOT_PARTITION" 12
Boot Partition
.IP "NVME_LOG_LID_PHY_RX_EOM" 12
-.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_cmd_get_log_telemetry_host_lsp \- Telemetry Host-Initiated log specific field
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_cmic" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_cmic \- This field indicates the controller multi-path I/O and NS sharing capabilities
+.SH SYNOPSIS
+enum nvme_cmic {
+.br
+.BI " NVME_CMIC_MULTI_PORT_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMIC_MULTI_CTRL_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMIC_MULTI_SRIOV_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMIC_MULTI_ANA_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMIC_MULTI_RSVD_SHIFT"
+,
+.br
+.br
+.BI " NVME_CMIC_MULTI_PORT_MASK"
+,
+.br
+.br
+.BI " NVME_CMIC_MULTI_CTRL_MASK"
+,
+.br
+.br
+.BI " NVME_CMIC_MULTI_SRIOV_MASK"
+,
+.br
+.br
+.BI " NVME_CMIC_MULTI_ANA_MASK"
+,
+.br
+.br
+.BI " NVME_CMIC_MULTI_RSVD_MASK"
+
+};
+.SH Constants
+.IP "NVME_CMIC_MULTI_PORT_SHIFT" 12
+Shift amount to get the NVM subsystem port
+.IP "NVME_CMIC_MULTI_CTRL_SHIFT" 12
+Shift amount to get the controllers
+.IP "NVME_CMIC_MULTI_SRIOV_SHIFT" 12
+Shift amount to get the SR-IOV virtual function
+.IP "NVME_CMIC_MULTI_ANA_SHIFT" 12
+Shift amount to get the asymmetric namespace access reporting
+.IP "NVME_CMIC_MULTI_RSVD_SHIFT" 12
+Shift amount to get the reserved
+.IP "NVME_CMIC_MULTI_PORT_MASK" 12
+Mask to get the NVM subsystem port
+.IP "NVME_CMIC_MULTI_CTRL_MASK" 12
+Mask to get the controllers
+.IP "NVME_CMIC_MULTI_SRIOV_MASK" 12
+Mask to get the SR-IOV virtual function
+.IP "NVME_CMIC_MULTI_ANA_MASK" 12
+Mask to get the asymmetric namespace access reporting
+.IP "NVME_CMIC_MULTI_RSVD_MASK" 12
+Mask to get the reserved
-.TH "nvme_compare" 9 "nvme_compare" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_compare" 9 "nvme_compare" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_compare \- Submit an nvme user compare command
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_connect_err" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_connect_err" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_connect_err \- nvme connect error codes
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_constants" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_constants" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_constants \- A place to stash various constant nvme values
.SH SYNOPSIS
-.TH "nvme_copy" 9 "nvme_copy" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_copy" 9 "nvme_copy" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_copy \- Copy command
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_copy_range" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_copy_range" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_copy_range \- Copy - Source Range Entries Descriptor Format
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_copy_range_f1" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_copy_range_f1" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_copy_range_f1 \- Copy - Source Range Entries Descriptor Format 1h
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_copy_range_f2" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_copy_range_f2" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_copy_range_f2 \- Copy - Source Range Entries Descriptor Format 2h
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_copy_range_f3" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_copy_range_f3" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_copy_range_f3 \- Copy - Source Range Entries Descriptor Format 3h
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_copy_range_sopt" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_copy_range_sopt" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_copy_range_sopt \- NVMe Copy Range Source Options
.SH SYNOPSIS
-.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_create_ctrl \- Allocate an unconnected NVMe controller
.SH SYNOPSIS
-.TH "nvme_create_root" 9 "nvme_create_root" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_create_root" 9 "nvme_create_root" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_create_root \- Initialize root object
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_crto" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_crto \- This field indicates the controller ready timeouts
+.SH SYNOPSIS
+enum nvme_crto {
+.br
+.BI " NVME_CRTO_CRWMT_SHIFT"
+,
+.br
+.br
+.BI " NVME_CRTO_CRIMT_SHIFT"
+,
+.br
+.br
+.BI " NVME_CRTO_CRWMT_MASK"
+,
+.br
+.br
+.BI " NVME_CRTO_CRIMT_MASK"
+
+};
+.SH Constants
+.IP "NVME_CRTO_CRWMT_SHIFT" 12
+Shift amount to get the controller ready with media timeout
+.IP "NVME_CRTO_CRIMT_SHIFT" 12
+Shift amount to get the controller ready independent of media timeout
+.IP "NVME_CRTO_CRWMT_MASK" 12
+Mask to get the controller ready with media timeout
+.IP "NVME_CRTO_CRIMT_MASK" 12
+Mask to get the controller ready independent of media timeout
-.TH "libnvme" 9 "enum nvme_csi" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_csi" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_csi \- Defined command set indicators
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_csts" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_csts \- This field indicates the controller status register
+.SH SYNOPSIS
+enum nvme_csts {
+.br
+.BI " NVME_CSTS_RDY_SHIFT"
+,
+.br
+.br
+.BI " NVME_CSTS_CFS_SHIFT"
+,
+.br
+.br
+.BI " NVME_CSTS_SHST_SHIFT"
+,
+.br
+.br
+.BI " NVME_CSTS_NSSRO_SHIFT"
+,
+.br
+.br
+.BI " NVME_CSTS_PP_SHIFT"
+,
+.br
+.br
+.BI " NVME_CSTS_ST_SHIFT"
+,
+.br
+.br
+.BI " NVME_CSTS_RDY_MASK"
+,
+.br
+.br
+.BI " NVME_CSTS_CFS_MASK"
+,
+.br
+.br
+.BI " NVME_CSTS_SHST_MASK"
+,
+.br
+.br
+.BI " NVME_CSTS_NSSRO_MASK"
+,
+.br
+.br
+.BI " NVME_CSTS_PP_MASK"
+,
+.br
+.br
+.BI " NVME_CSTS_ST_MASK"
+,
+.br
+.br
+.BI " NVME_CSTS_SHST_NORMAL"
+,
+.br
+.br
+.BI " NVME_CSTS_SHST_OCCUR"
+,
+.br
+.br
+.BI " NVME_CSTS_SHST_CMPLT"
+,
+.br
+.br
+.BI " NVME_CSTS_SHN_MASK"
+
+};
+.SH Constants
+.IP "NVME_CSTS_RDY_SHIFT" 12
+Shift amount to get the ready
+.IP "NVME_CSTS_CFS_SHIFT" 12
+Shift amount to get the controller fatal status
+.IP "NVME_CSTS_SHST_SHIFT" 12
+Shift amount to get the shutdown status
+.IP "NVME_CSTS_NSSRO_SHIFT" 12
+Shift amount to get the NVM subsystem reset occurred
+.IP "NVME_CSTS_PP_SHIFT" 12
+Shift amount to get the processing paused
+.IP "NVME_CSTS_ST_SHIFT" 12
+Shift amount to get the shutdown type
+.IP "NVME_CSTS_RDY_MASK" 12
+Mask to get the ready
+.IP "NVME_CSTS_CFS_MASK" 12
+Mask to get the controller fatal status
+.IP "NVME_CSTS_SHST_MASK" 12
+Mask to get the shutdown status
+.IP "NVME_CSTS_NSSRO_MASK" 12
+Mask to get the NVM subsystem reset occurred
+.IP "NVME_CSTS_PP_MASK" 12
+Mask to get the processing paused
+.IP "NVME_CSTS_ST_MASK" 12
+Mask to get the shutdown type
+.IP "NVME_CSTS_SHST_NORMAL" 12
+Normal operation
+.IP "NVME_CSTS_SHST_OCCUR" 12
+Shutdown processing occurring
+.IP "NVME_CSTS_SHST_CMPLT" 12
+Shutdown processing complete
+.IP "NVME_CSTS_SHN_MASK" 12
+Deprecated mask to get the shutdown status
-.TH "nvme_ctrl_config_match" 9 "nvme_ctrl_config_match" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_config_match" 9 "nvme_ctrl_config_match" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_config_match \- Check if ctrl @c matches config params
.SH SYNOPSIS
-.TH "nvme_ctrl_find" 9 "nvme_ctrl_find" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_find" 9 "nvme_ctrl_find" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_find \- Locate an existing controller
.SH SYNOPSIS
-.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_first_ns \- Start namespace iterator
.SH SYNOPSIS
-.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_first_path \- Start path iterator
.SH SYNOPSIS
-.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_ns \- Traverse namespaces
.SH SYNOPSIS
-.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_ns_safe \- Traverse namespaces
.SH SYNOPSIS
-.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_path \- Traverse paths
.SH SYNOPSIS
-.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_path_safe \- Traverse paths
.SH SYNOPSIS
-.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_address \- Address string of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_config \- Fabrics configuration of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_dhchap_host_key" 9 "nvme_ctrl_get_dhchap_host_key" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_dhchap_host_key" 9 "nvme_ctrl_get_dhchap_host_key" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_dhchap_host_key \- Return host key
.SH SYNOPSIS
-.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_dhchap_key \- Return controller key
.SH SYNOPSIS
-.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_fd \- Get associated file descriptor
.SH SYNOPSIS
-.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_firmware \- Firmware string of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_host_iface \- Host interface name of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_host_traddr \- Host transport address of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_model \- Model of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_name \- sysfs name of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_numa_node \- NUMA node of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_phy_slot" 9 "nvme_ctrl_get_phy_slot" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_phy_slot" 9 "nvme_ctrl_get_phy_slot" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_phy_slot \- PCI physical slot number of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_queue_count \- Queue count of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_serial \- Serial number of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_sqsize \- SQ size of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_src_addr" 9 "nvme_ctrl_get_src_addr" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_src_addr" 9 "nvme_ctrl_get_src_addr" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_src_addr \- Extract src_addr from the c->address string
.SH SYNOPSIS
-.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_state \- Running state of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_subsysnqn \- Subsystem NQN of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_subsystem \- Parent subsystem of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_sysfs_dir \- sysfs directory of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_traddr \- Transport address of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_transport \- Transport type of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_trsvcid \- Transport service identifier of a controller
.SH SYNOPSIS
-.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_identify \- Issues an 'identify controller' command
.SH SYNOPSIS
-.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_discovered \- Returns the value of the 'discovered' flag
.SH SYNOPSIS
-.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_discovery_ctrl \- Check the 'discovery_ctrl' flag
.SH SYNOPSIS
-.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_persistent \- Returns the value of the 'persistent' flag
.SH SYNOPSIS
-.TH "nvme_ctrl_is_unique_discovery_ctrl" 9 "nvme_ctrl_is_unique_discovery_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_is_unique_discovery_ctrl" 9 "nvme_ctrl_is_unique_discovery_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_unique_discovery_ctrl \- Check the 'unique_discovery_ctrl' flag
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_ctrl_list" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ctrl_list" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_ctrl_list \- Controller List
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ctrl_metadata_type \- Controller Metadata Element Types
.SH SYNOPSIS
-.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_next_ns \- Next namespace iterator
.SH SYNOPSIS
-.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_next_path \- Next path iterator
.SH SYNOPSIS
-.TH "nvme_ctrl_release_fd" 9 "nvme_ctrl_release_fd" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_release_fd" 9 "nvme_ctrl_release_fd" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_release_fd \- Close fd and clear fd from controller object
.SH SYNOPSIS
-.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_reset \- Initiate a controller reset
.SH SYNOPSIS
-.TH "nvme_ctrl_set_dhchap_host_key" 9 "nvme_ctrl_set_dhchap_host_key" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_set_dhchap_host_key" 9 "nvme_ctrl_set_dhchap_host_key" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_dhchap_host_key \- Set host key
.SH SYNOPSIS
-.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_dhchap_key \- Set controller key
.SH SYNOPSIS
-.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_discovered \- Set the 'discovered' flag
.SH SYNOPSIS
-.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_discovery_ctrl \- Set the 'discovery_ctrl' flag
.SH SYNOPSIS
-.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_persistent \- Set the 'persistent' flag
.SH SYNOPSIS
-.TH "nvme_ctrl_set_unique_discovery_ctrl" 9 "nvme_ctrl_set_unique_discovery_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrl_set_unique_discovery_ctrl" 9 "nvme_ctrl_set_unique_discovery_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_unique_discovery_ctrl \- Set the 'unique_discovery_ctrl' flag
.SH SYNOPSIS
-.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ctrls_filter \- Filter for controllers
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_data_tfr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_data_tfr" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_data_tfr \- Data transfer direction of the command
.SH SYNOPSIS
-.TH "nvme_default_host" 9 "nvme_default_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_default_host" 9 "nvme_default_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_default_host \- Initializes the default host
.SH SYNOPSIS
-.TH "nvme_describe_key_serial" 9 "nvme_describe_key_serial" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_describe_key_serial" 9 "nvme_describe_key_serial" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_describe_key_serial \- Return key description
.SH SYNOPSIS
-.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_dev_self_test \- Start or abort a self test
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_directive_dtype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_directive_dtype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_directive_dtype \- Directive Types
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_directive_receive_doper" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_directive_receive_doper" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_directive_receive_doper \- Directive Receive Directive Operation
.SH SYNOPSIS
-.TH "nvme_directive_recv" 9 "nvme_directive_recv" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_directive_recv" 9 "nvme_directive_recv" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv \- Receive directive specific data
.SH SYNOPSIS
-.TH "nvme_directive_recv_identify_parameters" 9 "nvme_directive_recv_identify_parameters" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_directive_recv_identify_parameters" 9 "nvme_directive_recv_identify_parameters" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv_identify_parameters \- Directive receive identifier parameters
.SH SYNOPSIS
-.TH "nvme_directive_recv_stream_allocate" 9 "nvme_directive_recv_stream_allocate" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_directive_recv_stream_allocate" 9 "nvme_directive_recv_stream_allocate" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv_stream_allocate \- Directive receive stream allocate
.SH SYNOPSIS
-.TH "nvme_directive_recv_stream_parameters" 9 "nvme_directive_recv_stream_parameters" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_directive_recv_stream_parameters" 9 "nvme_directive_recv_stream_parameters" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv_stream_parameters \- Directive receive stream parameters
.SH SYNOPSIS
-.TH "nvme_directive_recv_stream_status" 9 "nvme_directive_recv_stream_status" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_directive_recv_stream_status" 9 "nvme_directive_recv_stream_status" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv_stream_status \- Directive receive stream status
.SH SYNOPSIS
-.TH "nvme_directive_send" 9 "nvme_directive_send" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_directive_send" 9 "nvme_directive_send" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_directive_send \- Send directive command
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_directive_send_doper" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_directive_send_doper" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_directive_send_doper \- Directive Send Directive Operation
.SH SYNOPSIS
-.TH "nvme_directive_send_id_endir" 9 "nvme_directive_send_id_endir" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_directive_send_id_endir" 9 "nvme_directive_send_id_endir" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_directive_send_id_endir \- Directive Send Enable Directive
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_directive_send_identify_endir" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_directive_send_identify_endir" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_directive_send_identify_endir \- Enable Directive
.SH SYNOPSIS
-.TH "nvme_directive_send_stream_release_identifier" 9 "nvme_directive_send_stream_release_identifier" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_directive_send_stream_release_identifier" 9 "nvme_directive_send_stream_release_identifier" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_directive_send_stream_release_identifier \- Directive Send Stream release
.SH SYNOPSIS
-.TH "nvme_directive_send_stream_release_resource" 9 "nvme_directive_send_stream_release_resource" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_directive_send_stream_release_resource" 9 "nvme_directive_send_stream_release_resource" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_directive_send_stream_release_resource \- Directive Send Stream release resources
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_directive_types" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_directive_types" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_directive_types \- Directives Supported or Enabled
.SH SYNOPSIS
-.TH "nvme_disconnect_ctrl" 9 "nvme_disconnect_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_disconnect_ctrl" 9 "nvme_disconnect_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_disconnect_ctrl \- Disconnect a controller
.SH SYNOPSIS
-.TH "nvme_dsm" 9 "nvme_dsm" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_dsm" 9 "nvme_dsm" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_dsm \- Send an nvme data set management command
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_dsm_attributes" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_dsm_attributes" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_dsm_attributes \- Dataset Management attributes
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_dsm_range" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_dsm_range" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_dsm_range \- Dataset Management - Range Definition
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_dst_stc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_dst_stc" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_dst_stc \- Action taken by the Device Self-test command
.SH SYNOPSIS
-.TH "nvme_dump_config" 9 "nvme_dump_config" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_dump_config" 9 "nvme_dump_config" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_dump_config \- Print the JSON configuration
.SH SYNOPSIS
-.TH "nvme_dump_tree" 9 "nvme_dump_tree" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_dump_tree" 9 "nvme_dump_tree" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_dump_tree \- Dump internal object tree
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_eg_critical_warning_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_eg_critical_warning_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_eg_critical_warning_flags \- Endurance Group Information Log - Critical Warning
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_eg_event_aggregate_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_eg_event_aggregate_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_eg_event_aggregate_log \- Endurance Group Event Aggregate
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_end_grp_chan_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_end_grp_chan_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_end_grp_chan_desc \- Endurance Group Channel Configuration Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_end_grp_config_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_end_grp_config_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_end_grp_config_desc \- Endurance Group Configuration Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_endurance_group_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_endurance_group_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_endurance_group_log \- Endurance Group Information Log
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_eom_lane_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_eom_lane_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_eom_lane_desc \- EOM Lane Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_eom_optional_data" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_eom_optional_data" "May 2024" "API Manual" LINUX
.SH NAME
-enum nvme_eom_optional_data \- EOM Optional Data Present Fields
+enum nvme_eom_optional_data \- EOM Optional Data Present Fields (Deprecated)
.SH SYNOPSIS
enum nvme_eom_optional_data {
.br
-.BI " NVME_EOM_EYE_DATA_PRESENT"
+.BI " NVME_EOM_PRINTABLE_EYE_PRESENT"
,
.br
.br
-.BI " NVME_EOM_PRINTABLE_EYE_PRESENT"
+.BI " NVME_EOM_EYE_DATA_PRESENT"
};
.SH Constants
-.IP "NVME_EOM_EYE_DATA_PRESENT" 12
-Eye Data Present
.IP "NVME_EOM_PRINTABLE_EYE_PRESENT" 12
Printable Eye Present
+.IP "NVME_EOM_EYE_DATA_PRESENT" 12
+Eye Data Present
--- /dev/null
+.TH "libnvme" 9 "enum nvme_eom_optional_data_present" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_eom_optional_data_present \- EOM Optional Data Present Fields
+.SH SYNOPSIS
+enum nvme_eom_optional_data_present {
+.br
+.BI " NVME_EOM_ODP_PEFP_SHIFT"
+,
+.br
+.br
+.BI " NVME_EOM_ODP_EDFP_SHIFT"
+,
+.br
+.br
+.BI " NVME_EOM_ODP_RSVD_SHIFT"
+,
+.br
+.br
+.BI " NVME_EOM_ODP_PEFP_MASK"
+,
+.br
+.br
+.BI " NVME_EOM_ODP_EDFP_MASK"
+,
+.br
+.br
+.BI " NVME_EOM_ODP_RSVD_MASK"
+
+};
+.SH Constants
+.IP "NVME_EOM_ODP_PEFP_SHIFT" 12
+Shift amount to get the printable eye field present
+from the \fIstruct nvme_phy_rx_eom_log\fP.odp field.
+.IP "NVME_EOM_ODP_EDFP_SHIFT" 12
+Shift amount to get the eye data field present
+from the \fIstruct nvme_phy_rx_eom_log\fP.odp field.
+.IP "NVME_EOM_ODP_RSVD_SHIFT" 12
+Shift amount to get the reserved optional data present
+from the \fIstruct nvme_phy_rx_eom_log\fP.odp field.
+.IP "NVME_EOM_ODP_PEFP_MASK" 12
+Mask to get the printable eye field present
+from the \fIstruct nvme_phy_rx_eom_log\fP.odp field.
+.IP "NVME_EOM_ODP_EDFP_MASK" 12
+Mask to get the eye data field present
+from the \fIstruct nvme_phy_rx_eom_log\fP.odp field.
+.IP "NVME_EOM_ODP_RSVD_MASK" 12
+Mask to get the reserved data present
+from the \fIstruct nvme_phy_rx_eom_log\fP.odp field.
-.TH "nvme_errno_to_string" 9 "nvme_errno_to_string" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_errno_to_string" 9 "nvme_errno_to_string" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_errno_to_string \- Returns string describing nvme connect failures
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_error_log_page" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_error_log_page" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_error_log_page \- Error Information Log Entry (Log Identifier 01h)
.SH SYNOPSIS
--- /dev/null
+.TH "nvme_export_tls_key" 9 "nvme_export_tls_key" "May 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_export_tls_key \- Export a TLS key
+.SH SYNOPSIS
+.B "char *" nvme_export_tls_key
+.BI "(const unsigned char *key_data " ","
+.BI "int key_len " ");"
+.SH ARGUMENTS
+.IP "key_data" 12
+Raw data of the key
+.IP "key_len" 12
+Length of \fIkey_data\fP
+.SH "DESCRIPTION"
+Returns \fIkey_data\fP in the PSK Interchange format as defined in section
+3.6.1.5 of the NVMe TCP Transport specification.
+.SH "RETURN"
+The string containing the TLS identity or NULL with errno set
+on error. It is the responsibility of the caller to free the returned
+string.
-.TH "libnvme" 9 "struct nvme_fabrics_config" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fabrics_config" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fabrics_config \- Defines all linux nvme fabrics initiator options
.SH SYNOPSIS
.br
.BI " int tos;"
.br
-.BI " int keyring;"
+.BI " long keyring;"
.br
-.BI " int tls_key;"
+.BI " long tls_key;"
.br
.BI " bool duplicate_connect;"
.br
-.TH "libnvme" 9 "enum nvme_fctype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fctype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_fctype \- Fabrics Command Types
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_config_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_config_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_config_desc \- FDP Configuration Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_fdp_config_fdpa" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fdp_config_fdpa" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_fdp_config_fdpa \- FDP Attributes
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_config_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_config_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_config_log \- FDP Configurations Log Page
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_event \- FDP Event
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_fdp_event_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fdp_event_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_fdp_event_flags \- FDP Event Flags
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_event_realloc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_event_realloc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_event_realloc \- Media Reallocated Event Type Specific Information
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_fdp_event_realloc_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fdp_event_realloc_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_fdp_event_realloc_flags \- Media Reallocated Event Type Specific Flags
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_fdp_event_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fdp_event_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_fdp_event_type \- FDP Event Types
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_events_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_events_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_events_log \- FDP Events Log Page
.SH SYNOPSIS
-.TH "nvme_fdp_reclaim_unit_handle_status" 9 "nvme_fdp_reclaim_unit_handle_status" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_fdp_reclaim_unit_handle_status" 9 "nvme_fdp_reclaim_unit_handle_status" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_fdp_reclaim_unit_handle_status \- Get reclaim unit handle status
.SH SYNOPSIS
-.TH "nvme_fdp_reclaim_unit_handle_update" 9 "nvme_fdp_reclaim_unit_handle_update" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_fdp_reclaim_unit_handle_update" 9 "nvme_fdp_reclaim_unit_handle_update" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_fdp_reclaim_unit_handle_update \- Update a list of reclaim unit handles
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_ruh_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_ruh_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_ruh_desc \- Reclaim Unit Handle Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_ruh_status" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_ruh_status" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_ruh_status \- Reclaim Unit Handle Status
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_ruh_status_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_ruh_status_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_ruh_status_desc \- Reclaim Unit Handle Status Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_fdp_ruh_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fdp_ruh_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_fdp_ruh_type \- Reclaim Unit Handle Type
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_fdp_ruha" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fdp_ruha" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_fdp_ruha \- Reclaim Unit Handle Attributes
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_ruhu_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_ruhu_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_ruhu_desc \- Reclaim Unit Handle Usage Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_ruhu_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_ruhu_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_ruhu_log \- Reclaim Unit Handle Usage Log Page
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_stats_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_stats_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_stats_log \- FDP Statistics Log Page
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_fdp_supported_event_attributes" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fdp_supported_event_attributes" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_fdp_supported_event_attributes \- Supported FDP Event Attributes
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fdp_supported_event_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fdp_supported_event_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fdp_supported_event_desc \- Supported FDP Event Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_feat" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_feat" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_feat \- Features Access Shifts/Masks values
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_feat_auto_pst" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_feat_auto_pst" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_feat_auto_pst \- Autonomous Power State Transition
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_feat_fdp_events_cdw11" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_feat_fdp_events_cdw11" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_feat_fdp_events_cdw11 \- FDP Events Feature Command Dword 11
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_feat_host_behavior" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_feat_host_behavior" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_feat_host_behavior \- Host Behavior Support - Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_feat_nswpcfg_state" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_feat_nswpcfg_state" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_feat_nswpcfg_state \- Write Protection - Write Protection State
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_feat_plm_window_select" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_feat_plm_window_select" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_feat_plm_window_select \- Predictable Latency Per NVM Set Log
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_feat_resv_notify_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_feat_resv_notify_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_feat_resv_notify_flags \- Reservation Notification Configuration
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_feat_tmpthresh_thsel" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_feat_tmpthresh_thsel" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_feat_tmpthresh_thsel \- Temperature Threshold - Threshold Type Select
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_features_async_event_config_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_features_async_event_config_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_features_async_event_config_flags \- Asynchronous Event Configuration configuration flags
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_features_id" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_features_id" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_features_id \- Features - Feature Identifiers
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_fid_supported_effects" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fid_supported_effects" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_fid_supported_effects \- FID Supported and Effects Data Structure definitions
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fid_supported_effects_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fid_supported_effects_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fid_supported_effects_log \- Feature Identifiers Supported and Effects
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_firmware_slot" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_firmware_slot" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_firmware_slot \- Firmware Slot Information Log
.SH SYNOPSIS
-.TH "nvme_first_host" 9 "nvme_first_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_first_host" 9 "nvme_first_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_first_host \- Start host iterator
.SH SYNOPSIS
-.TH "nvme_first_subsystem" 9 "nvme_first_subsystem" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_first_subsystem" 9 "nvme_first_subsystem" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_first_subsystem \- Start subsystem iterator
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_flbas" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_flbas \- This field indicates the formatted LBA size
+.SH SYNOPSIS
+enum nvme_flbas {
+.br
+.BI " NVME_FLBAS_LOWER_SHIFT"
+,
+.br
+.br
+.BI " NVME_FLBAS_META_EXT_SHIFT"
+,
+.br
+.br
+.BI " NVME_FLBAS_HIGHER_SHIFT"
+,
+.br
+.br
+.BI " NVME_FLBAS_LOWER_MASK"
+,
+.br
+.br
+.BI " NVME_FLBAS_META_EXT_MASK"
+,
+.br
+.br
+.BI " NVME_FLBAS_HIGHER_MASK"
+
+};
+.SH Constants
+.IP "NVME_FLBAS_LOWER_SHIFT" 12
+Shift amount to get the format index least significant 4 bits
+.IP "NVME_FLBAS_META_EXT_SHIFT" 12
+Shift amount to get the metadata transferred
+.IP "NVME_FLBAS_HIGHER_SHIFT" 12
+Shift amount to get the format index most significant 2 bits
+.IP "NVME_FLBAS_LOWER_MASK" 12
+Mask to get the format index least significant 4 bits
+.IP "NVME_FLBAS_META_EXT_MASK" 12
+Mask to get the metadata transferred
+.IP "NVME_FLBAS_HIGHER_MASK" 12
+Mask to get the format index most significant 2 bits
-.TH "nvme_flush" 9 "nvme_flush" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_flush" 9 "nvme_flush" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_flush \- Send an nvme flush command
.SH SYNOPSIS
-.TH "nvme_for_each_host" 9 "nvme_for_each_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_for_each_host" 9 "nvme_for_each_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_for_each_host \- Traverse host list
.SH SYNOPSIS
-.TH "nvme_for_each_host_safe" 9 "nvme_for_each_host_safe" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_for_each_host_safe" 9 "nvme_for_each_host_safe" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_for_each_host_safe \- Traverse host list
.SH SYNOPSIS
-.TH "nvme_for_each_subsystem" 9 "nvme_for_each_subsystem" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_for_each_subsystem" 9 "nvme_for_each_subsystem" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_for_each_subsystem \- Traverse subsystems
.SH SYNOPSIS
-.TH "nvme_for_each_subsystem_safe" 9 "nvme_for_each_subsystem_safe" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_for_each_subsystem_safe" 9 "nvme_for_each_subsystem_safe" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_for_each_subsystem_safe \- Traverse subsystems
.SH SYNOPSIS
-.TH "nvme_format_nvm" 9 "nvme_format_nvm" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_format_nvm" 9 "nvme_format_nvm" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_format_nvm \- Format nvme namespace(s)
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_format_nvm_compln_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_format_nvm_compln_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_format_nvm_compln_event \- Format NVM Completion Event Data
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_format_nvm_start_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_format_nvm_start_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_format_nvm_start_event \- Format NVM Start Event Data
.SH SYNOPSIS
-.TH "nvme_free_ctrl" 9 "nvme_free_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_free_ctrl" 9 "nvme_free_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_free_ctrl \- Free controller
.SH SYNOPSIS
-.TH "nvme_free_host" 9 "nvme_free_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_free_host" 9 "nvme_free_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_free_host \- Free nvme_host_t object
.SH SYNOPSIS
-.TH "nvme_free_ns" 9 "nvme_free_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_free_ns" 9 "nvme_free_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_free_ns \- Free a namespace object
.SH SYNOPSIS
-.TH "nvme_free_subsystem" 9 "nvme_free_subsystem" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_free_subsystem" 9 "nvme_free_subsystem" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_free_subsystem \- Free a subsystem
.SH SYNOPSIS
-.TH "nvme_free_tree" 9 "nvme_free_tree" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_free_tree" 9 "nvme_free_tree" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_free_tree \- Free root object
.SH SYNOPSIS
-.TH "nvme_fw_commit" 9 "nvme_fw_commit" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_fw_commit" 9 "nvme_fw_commit" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_fw_commit \- Commit firmware using the specified action
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_fw_commit_ca" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fw_commit_ca" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_fw_commit_ca \- Firmware Commit - Commit Action
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_fw_commit_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fw_commit_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_fw_commit_event \- Firmware Commit Event Data
.SH SYNOPSIS
-.TH "nvme_fw_download" 9 "nvme_fw_download" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_fw_download" 9 "nvme_fw_download" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_fw_download \- Download part or all of a firmware image to the controller
.SH SYNOPSIS
-.TH "nvme_fw_download_seq" 9 "nvme_fw_download_seq" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_fw_download_seq" 9 "nvme_fw_download_seq" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_fw_download_seq \- Firmware download sequence
.SH SYNOPSIS
-.TH "nvme_gen_dhchap_key" 9 "nvme_gen_dhchap_key" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_gen_dhchap_key" 9 "nvme_gen_dhchap_key" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_gen_dhchap_key \- DH-HMAC-CHAP key generation
.SH SYNOPSIS
-.TH "nvme_generate_tls_key_identity" 9 "nvme_generate_tls_key_identity" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_generate_tls_key_identity" 9 "nvme_generate_tls_key_identity" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_generate_tls_key_identity \- Generate the TLS key identity
.SH SYNOPSIS
-.TH "nvme_get_ana_log_len" 9 "nvme_get_ana_log_len" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_ana_log_len" 9 "nvme_get_ana_log_len" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_ana_log_len \- Retrieve size of the current ANA log
.SH SYNOPSIS
-.TH "nvme_get_attr" 9 "nvme_get_attr" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_attr" 9 "nvme_get_attr" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_attr \- Read sysfs attribute
.SH SYNOPSIS
-.TH "nvme_get_ctrl_attr" 9 "nvme_get_ctrl_attr" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_ctrl_attr" 9 "nvme_get_ctrl_attr" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_ctrl_attr \- Read controller sysfs attribute
.SH SYNOPSIS
-.TH "nvme_get_ctrl_telemetry" 9 "nvme_get_ctrl_telemetry" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_ctrl_telemetry" 9 "nvme_get_ctrl_telemetry" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_ctrl_telemetry \- Get controller telemetry log
.SH SYNOPSIS
-.TH "nvme_get_directive_receive_length" 9 "nvme_get_directive_receive_length" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_directive_receive_length" 9 "nvme_get_directive_receive_length" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_directive_receive_length \- Get directive receive length
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_get_discovery_args" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_get_discovery_args" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_get_discovery_args \- Arguments for nvmf_get_discovery_wargs()
.SH SYNOPSIS
-.TH "nvme_get_feature_length" 9 "nvme_get_feature_length" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_feature_length" 9 "nvme_get_feature_length" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_feature_length \- Retreive the command payload length for a specific feature identifier
.SH SYNOPSIS
-.TH "nvme_get_feature_length2" 9 "nvme_get_feature_length2" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_feature_length2" 9 "nvme_get_feature_length2" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_feature_length2 \- Retreive the command payload length for a specific feature identifier
.SH SYNOPSIS
-.TH "nvme_get_features" 9 "nvme_get_features" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features" 9 "nvme_get_features" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features \- Retrieve a feature attribute
.SH SYNOPSIS
-.TH "nvme_get_features_arbitration" 9 "nvme_get_features_arbitration" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_arbitration" 9 "nvme_get_features_arbitration" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_arbitration \- Get arbitration feature
.SH SYNOPSIS
-.TH "nvme_get_features_async_event" 9 "nvme_get_features_async_event" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_async_event" 9 "nvme_get_features_async_event" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_async_event \- Get asynchronous event feature
.SH SYNOPSIS
-.TH "nvme_get_features_auto_pst" 9 "nvme_get_features_auto_pst" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_auto_pst" 9 "nvme_get_features_auto_pst" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_auto_pst \- Get autonomous power state feature
.SH SYNOPSIS
-.TH "nvme_get_features_data" 9 "nvme_get_features_data" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_data" 9 "nvme_get_features_data" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_data \- Helper function for @nvme_get_features()
.SH SYNOPSIS
-.TH "nvme_get_features_endurance_event_cfg" 9 "nvme_get_features_endurance_event_cfg" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_endurance_event_cfg" 9 "nvme_get_features_endurance_event_cfg" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_endurance_event_cfg \- Get endurance event config feature
.SH SYNOPSIS
-.TH "nvme_get_features_err_recovery" 9 "nvme_get_features_err_recovery" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_err_recovery" 9 "nvme_get_features_err_recovery" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_err_recovery \- Get error recovery feature
.SH SYNOPSIS
-.TH "nvme_get_features_err_recovery2" 9 "nvme_get_features_err_recovery2" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_err_recovery2" 9 "nvme_get_features_err_recovery2" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_err_recovery2 \- Get error recovery feature
.SH SYNOPSIS
-.TH "nvme_get_features_hctm" 9 "nvme_get_features_hctm" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_hctm" 9 "nvme_get_features_hctm" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_hctm \- Get thermal management feature
.SH SYNOPSIS
-.TH "nvme_get_features_host_behavior" 9 "nvme_get_features_host_behavior" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_host_behavior" 9 "nvme_get_features_host_behavior" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_host_behavior \- Get host behavior feature
.SH SYNOPSIS
-.TH "nvme_get_features_host_id" 9 "nvme_get_features_host_id" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_host_id" 9 "nvme_get_features_host_id" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_host_id \- Get host id feature
.SH SYNOPSIS
-.TH "nvme_get_features_host_mem_buf" 9 "nvme_get_features_host_mem_buf" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_host_mem_buf" 9 "nvme_get_features_host_mem_buf" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_host_mem_buf \- Get host memory buffer feature
.SH SYNOPSIS
-.TH "nvme_get_features_host_mem_buf2" 9 "nvme_get_features_host_mem_buf2" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_host_mem_buf2" 9 "nvme_get_features_host_mem_buf2" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_host_mem_buf2 \- Get host memory buffer feature
.SH SYNOPSIS
-.TH "nvme_get_features_iocs_profile" 9 "nvme_get_features_iocs_profile" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_iocs_profile" 9 "nvme_get_features_iocs_profile" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_iocs_profile \- Get IOCS profile feature
.SH SYNOPSIS
-.TH "nvme_get_features_irq_coalesce" 9 "nvme_get_features_irq_coalesce" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_irq_coalesce" 9 "nvme_get_features_irq_coalesce" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_irq_coalesce \- Get IRQ coalesce feature
.SH SYNOPSIS
-.TH "nvme_get_features_irq_config" 9 "nvme_get_features_irq_config" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_irq_config" 9 "nvme_get_features_irq_config" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_irq_config \- Get IRQ config feature
.SH SYNOPSIS
-.TH "nvme_get_features_kato" 9 "nvme_get_features_kato" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_kato" 9 "nvme_get_features_kato" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_kato \- Get keep alive timeout feature
.SH SYNOPSIS
-.TH "nvme_get_features_lba_range" 9 "nvme_get_features_lba_range" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_lba_range" 9 "nvme_get_features_lba_range" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_lba_range \- Get LBA range feature
.SH SYNOPSIS
-.TH "nvme_get_features_lba_range2" 9 "nvme_get_features_lba_range2" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_lba_range2" 9 "nvme_get_features_lba_range2" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_lba_range2 \- Get LBA range feature
.SH SYNOPSIS
-.TH "nvme_get_features_lba_sts_interval" 9 "nvme_get_features_lba_sts_interval" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_lba_sts_interval" 9 "nvme_get_features_lba_sts_interval" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_lba_sts_interval \- Get LBA status information feature
.SH SYNOPSIS
-.TH "nvme_get_features_nopsc" 9 "nvme_get_features_nopsc" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_nopsc" 9 "nvme_get_features_nopsc" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_nopsc \- Get non-operational power state feature
.SH SYNOPSIS
-.TH "nvme_get_features_num_queues" 9 "nvme_get_features_num_queues" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_num_queues" 9 "nvme_get_features_num_queues" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_num_queues \- Get number of queues feature
.SH SYNOPSIS
-.TH "nvme_get_features_plm_config" 9 "nvme_get_features_plm_config" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_plm_config" 9 "nvme_get_features_plm_config" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_plm_config \- Get predictable latency feature
.SH SYNOPSIS
-.TH "nvme_get_features_plm_window" 9 "nvme_get_features_plm_window" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_plm_window" 9 "nvme_get_features_plm_window" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_plm_window \- Get window select feature
.SH SYNOPSIS
-.TH "nvme_get_features_power_mgmt" 9 "nvme_get_features_power_mgmt" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_power_mgmt" 9 "nvme_get_features_power_mgmt" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_power_mgmt \- Get power management feature
.SH SYNOPSIS
-.TH "nvme_get_features_resv_mask" 9 "nvme_get_features_resv_mask" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_resv_mask" 9 "nvme_get_features_resv_mask" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_resv_mask \- Get reservation mask feature
.SH SYNOPSIS
-.TH "nvme_get_features_resv_mask2" 9 "nvme_get_features_resv_mask2" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_resv_mask2" 9 "nvme_get_features_resv_mask2" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_resv_mask2 \- Get reservation mask feature
.SH SYNOPSIS
-.TH "nvme_get_features_resv_persist" 9 "nvme_get_features_resv_persist" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_resv_persist" 9 "nvme_get_features_resv_persist" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_resv_persist \- Get reservation persist feature
.SH SYNOPSIS
-.TH "nvme_get_features_resv_persist2" 9 "nvme_get_features_resv_persist2" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_resv_persist2" 9 "nvme_get_features_resv_persist2" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_resv_persist2 \- Get reservation persist feature
.SH SYNOPSIS
-.TH "nvme_get_features_rrl" 9 "nvme_get_features_rrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_rrl" 9 "nvme_get_features_rrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_rrl \- Get read recovery level feature
.SH SYNOPSIS
-.TH "nvme_get_features_sanitize" 9 "nvme_get_features_sanitize" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_sanitize" 9 "nvme_get_features_sanitize" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_sanitize \- Get sanitize feature
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_get_features_sel" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_get_features_sel" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_get_features_sel \- Get Features - Select
.SH SYNOPSIS
-.TH "nvme_get_features_simple" 9 "nvme_get_features_simple" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_simple" 9 "nvme_get_features_simple" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_simple \- Helper function for @nvme_get_features()
.SH SYNOPSIS
-.TH "nvme_get_features_sw_progress" 9 "nvme_get_features_sw_progress" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_sw_progress" 9 "nvme_get_features_sw_progress" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_sw_progress \- Get software progress feature
.SH SYNOPSIS
-.TH "nvme_get_features_temp_thresh" 9 "nvme_get_features_temp_thresh" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_temp_thresh" 9 "nvme_get_features_temp_thresh" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_temp_thresh \- Get temperature threshold feature
.SH SYNOPSIS
-.TH "nvme_get_features_timestamp" 9 "nvme_get_features_timestamp" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_timestamp" 9 "nvme_get_features_timestamp" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_timestamp \- Get timestamp feature
.SH SYNOPSIS
-.TH "nvme_get_features_volatile_wc" 9 "nvme_get_features_volatile_wc" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_volatile_wc" 9 "nvme_get_features_volatile_wc" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_volatile_wc \- Get volatile write cache feature
.SH SYNOPSIS
-.TH "nvme_get_features_write_atomic" 9 "nvme_get_features_write_atomic" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_write_atomic" 9 "nvme_get_features_write_atomic" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_write_atomic \- Get write atomic feature
.SH SYNOPSIS
-.TH "nvme_get_features_write_protect" 9 "nvme_get_features_write_protect" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_features_write_protect" 9 "nvme_get_features_write_protect" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_features_write_protect \- Get write protect feature
.SH SYNOPSIS
-.TH "nvme_get_host_telemetry" 9 "nvme_get_host_telemetry" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_host_telemetry" 9 "nvme_get_host_telemetry" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_host_telemetry \- Get host telemetry log
.SH SYNOPSIS
-.TH "nvme_get_lba_status" 9 "nvme_get_lba_status" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_lba_status" 9 "nvme_get_lba_status" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_lba_status \- Retrieve information on possibly unrecoverable LBAs
.SH SYNOPSIS
-.TH "nvme_get_lba_status_log" 9 "nvme_get_lba_status_log" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_lba_status_log" 9 "nvme_get_lba_status_log" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_lba_status_log \- Retrieve the LBA Status log page
.SH SYNOPSIS
-.TH "nvme_get_log" 9 "nvme_get_log" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log" 9 "nvme_get_log" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log \- NVMe Admin Get Log command
.SH SYNOPSIS
-.TH "nvme_get_log_ana" 9 "nvme_get_log_ana" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_ana" 9 "nvme_get_log_ana" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_ana \- Retrieve Asymmetric Namespace Access log page
.SH SYNOPSIS
-.TH "nvme_get_log_ana_groups" 9 "nvme_get_log_ana_groups" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_ana_groups" 9 "nvme_get_log_ana_groups" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_ana_groups \- Retrieve Asymmetric Namespace Access groups only log page
.SH SYNOPSIS
-.TH "nvme_get_log_boot_partition" 9 "nvme_get_log_boot_partition" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_boot_partition" 9 "nvme_get_log_boot_partition" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_boot_partition \- Retrieve Boot Partition
.SH SYNOPSIS
-.TH "nvme_get_log_changed_ns_list" 9 "nvme_get_log_changed_ns_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_changed_ns_list" 9 "nvme_get_log_changed_ns_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_changed_ns_list \- Retrieve namespace changed list
.SH SYNOPSIS
-.TH "nvme_get_log_cmd_effects" 9 "nvme_get_log_cmd_effects" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_cmd_effects" 9 "nvme_get_log_cmd_effects" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_cmd_effects \- Retrieve nvme command effects log
.SH SYNOPSIS
-.TH "nvme_get_log_create_telemetry_host" 9 "nvme_get_log_create_telemetry_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_create_telemetry_host" 9 "nvme_get_log_create_telemetry_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_create_telemetry_host \- Create host telemetry log
.SH SYNOPSIS
-.TH "nvme_get_log_device_self_test" 9 "nvme_get_log_device_self_test" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_device_self_test" 9 "nvme_get_log_device_self_test" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_device_self_test \- Retrieve the device self test log
.SH SYNOPSIS
-.TH "nvme_get_log_discovery" 9 "nvme_get_log_discovery" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_discovery" 9 "nvme_get_log_discovery" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_discovery \- Retrieve Discovery log page
.SH SYNOPSIS
-.TH "nvme_get_log_endurance_group" 9 "nvme_get_log_endurance_group" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_endurance_group" 9 "nvme_get_log_endurance_group" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_endurance_group \- Get Endurance Group log
.SH SYNOPSIS
-.TH "nvme_get_log_endurance_grp_evt" 9 "nvme_get_log_endurance_grp_evt" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_endurance_grp_evt" 9 "nvme_get_log_endurance_grp_evt" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_endurance_grp_evt \- Retrieve Rotational Media Information
.SH SYNOPSIS
-.TH "nvme_get_log_error" 9 "nvme_get_log_error" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_error" 9 "nvme_get_log_error" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_error \- Retrieve nvme error log
.SH SYNOPSIS
-.TH "nvme_get_log_fdp_configurations" 9 "nvme_get_log_fdp_configurations" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_fdp_configurations" 9 "nvme_get_log_fdp_configurations" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_fdp_configurations \- Get list of Flexible Data Placement configurations
.SH SYNOPSIS
-.TH "nvme_get_log_fdp_events" 9 "nvme_get_log_fdp_events" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_fdp_events" 9 "nvme_get_log_fdp_events" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_fdp_events \- Get Flexible Data Placement events
.SH SYNOPSIS
-.TH "nvme_get_log_fdp_stats" 9 "nvme_get_log_fdp_stats" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_fdp_stats" 9 "nvme_get_log_fdp_stats" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_fdp_stats \- Get Flexible Data Placement statistics
.SH SYNOPSIS
-.TH "nvme_get_log_fid_supported_effects" 9 "nvme_get_log_fid_supported_effects" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_fid_supported_effects" 9 "nvme_get_log_fid_supported_effects" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_fid_supported_effects \- Retrieve Feature Identifiers Supported and Effects
.SH SYNOPSIS
-.TH "nvme_get_log_fw_slot" 9 "nvme_get_log_fw_slot" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_fw_slot" 9 "nvme_get_log_fw_slot" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_fw_slot \- Retrieves the controller firmware log
.SH SYNOPSIS
-.TH "nvme_get_log_lba_status" 9 "nvme_get_log_lba_status" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_lba_status" 9 "nvme_get_log_lba_status" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_lba_status \- Retrieve LBA Status
.SH SYNOPSIS
-.TH "nvme_get_log_media_unit_stat" 9 "nvme_get_log_media_unit_stat" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_media_unit_stat" 9 "nvme_get_log_media_unit_stat" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_media_unit_stat \- Retrieve Media Unit Status
.SH SYNOPSIS
-.TH "nvme_get_log_mi_cmd_supported_effects" 9 "nvme_get_log_mi_cmd_supported_effects" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_mi_cmd_supported_effects" 9 "nvme_get_log_mi_cmd_supported_effects" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_mi_cmd_supported_effects \- displays the MI Commands Supported by the controller
.SH SYNOPSIS
-.TH "nvme_get_log_page" 9 "nvme_get_log_page" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_page" 9 "nvme_get_log_page" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_page \- Get log page data
.SH SYNOPSIS
-.TH "nvme_get_log_persistent_event" 9 "nvme_get_log_persistent_event" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_persistent_event" 9 "nvme_get_log_persistent_event" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_persistent_event \- Retrieve Persistent Event Log
.SH SYNOPSIS
-.TH "nvme_get_log_phy_rx_eom" 9 "nvme_get_log_phy_rx_eom" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_phy_rx_eom" 9 "nvme_get_log_phy_rx_eom" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_phy_rx_eom \- Retrieve Physical Interface Receiver Eye Opening Measurement Log
.SH SYNOPSIS
-.TH "nvme_get_log_predictable_lat_event" 9 "nvme_get_log_predictable_lat_event" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_predictable_lat_event" 9 "nvme_get_log_predictable_lat_event" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_predictable_lat_event \- Retrieve Predictable Latency Event Aggregate Log Page
.SH SYNOPSIS
-.TH "nvme_get_log_predictable_lat_nvmset" 9 "nvme_get_log_predictable_lat_nvmset" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_predictable_lat_nvmset" 9 "nvme_get_log_predictable_lat_nvmset" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_predictable_lat_nvmset \- Predictable Latency Per NVM Set
.SH SYNOPSIS
-.TH "nvme_get_log_reclaim_unit_handle_usage" 9 "nvme_get_log_reclaim_unit_handle_usage" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_reclaim_unit_handle_usage" 9 "nvme_get_log_reclaim_unit_handle_usage" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_reclaim_unit_handle_usage \- Get reclaim unit handle usage
.SH SYNOPSIS
-.TH "nvme_get_log_reservation" 9 "nvme_get_log_reservation" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_reservation" 9 "nvme_get_log_reservation" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_reservation \- Retrieve Reservation Notification
.SH SYNOPSIS
-.TH "nvme_get_log_sanitize" 9 "nvme_get_log_sanitize" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_sanitize" 9 "nvme_get_log_sanitize" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_sanitize \- Retrieve Sanitize Status
.SH SYNOPSIS
-.TH "nvme_get_log_smart" 9 "nvme_get_log_smart" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_smart" 9 "nvme_get_log_smart" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_smart \- Retrieve nvme smart log
.SH SYNOPSIS
-.TH "nvme_get_log_support_cap_config_list" 9 "nvme_get_log_support_cap_config_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_support_cap_config_list" 9 "nvme_get_log_support_cap_config_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_support_cap_config_list \- Retrieve Supported Capacity Configuration List
.SH SYNOPSIS
-.TH "nvme_get_log_supported_log_pages" 9 "nvme_get_log_supported_log_pages" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_supported_log_pages" 9 "nvme_get_log_supported_log_pages" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_supported_log_pages \- Retrieve nmve supported log pages
.SH SYNOPSIS
-.TH "nvme_get_log_telemetry_ctrl" 9 "nvme_get_log_telemetry_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_telemetry_ctrl" 9 "nvme_get_log_telemetry_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_telemetry_ctrl \- Get Telemetry Controller-Initiated log page
.SH SYNOPSIS
-.TH "nvme_get_log_telemetry_host" 9 "nvme_get_log_telemetry_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_telemetry_host" 9 "nvme_get_log_telemetry_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_telemetry_host \- Get Telemetry Host-Initiated log page
.SH SYNOPSIS
-.TH "nvme_get_log_zns_changed_zones" 9 "nvme_get_log_zns_changed_zones" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_log_zns_changed_zones" 9 "nvme_get_log_zns_changed_zones" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_log_zns_changed_zones \- Retrieve list of zones that have changed
.SH SYNOPSIS
--- /dev/null
+.TH "nvme_get_logging_level" 9 "nvme_get_logging_level" "May 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_get_logging_level \- Get current logging level
+.SH SYNOPSIS
+.B "int" nvme_get_logging_level
+.BI "(nvme_root_t r " ","
+.BI "bool *log_pid " ","
+.BI "bool *log_tstamp " ");"
+.SH ARGUMENTS
+.IP "r" 12
+nvme_root_t context
+.IP "log_pid" 12
+Pointer to store a current value of logging of
+the PID flag at (optional).
+.IP "log_tstamp" 12
+Pointer to store a current value of logging of
+the timestamp flag at (optional).
+.SH "DESCRIPTION"
+Retrieves current values of logging variables.
+.SH "RETURN"
+current log level value or DEFAULT_LOGLEVEL if not initialized.
-.TH "nvme_get_logical_block_size" 9 "nvme_get_logical_block_size" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_logical_block_size" 9 "nvme_get_logical_block_size" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_logical_block_size \- Retrieve block size
.SH SYNOPSIS
-.TH "nvme_get_new_host_telemetry" 9 "nvme_get_new_host_telemetry" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_new_host_telemetry" 9 "nvme_get_new_host_telemetry" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_new_host_telemetry \- Get new host telemetry log
.SH SYNOPSIS
-.TH "nvme_get_ns_attr" 9 "nvme_get_ns_attr" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_ns_attr" 9 "nvme_get_ns_attr" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_ns_attr \- Read namespace sysfs attribute
.SH SYNOPSIS
-.TH "nvme_get_nsid" 9 "nvme_get_nsid" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_nsid" 9 "nvme_get_nsid" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_nsid \- Retrieve the NSID from a namespace file descriptor
.SH SYNOPSIS
-.TH "nvme_get_path_attr" 9 "nvme_get_path_attr" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_path_attr" 9 "nvme_get_path_attr" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_path_attr \- Read path sysfs attribute
.SH SYNOPSIS
-.TH "nvme_get_property" 9 "nvme_get_property" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_property" 9 "nvme_get_property" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_property \- Get a controller property
.SH SYNOPSIS
-.TH "nvme_get_subsys_attr" 9 "nvme_get_subsys_attr" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_subsys_attr" 9 "nvme_get_subsys_attr" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_subsys_attr \- Read subsystem sysfs attribute
.SH SYNOPSIS
-.TH "nvme_get_telemetry_log" 9 "nvme_get_telemetry_log" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_telemetry_log" 9 "nvme_get_telemetry_log" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_telemetry_log \- Get specified telemetry log
.SH SYNOPSIS
-.TH "nvme_get_telemetry_max" 9 "nvme_get_telemetry_max" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_get_telemetry_max" 9 "nvme_get_telemetry_max" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_get_telemetry_max \- Get telemetry limits
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_hmac_alg" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_hmac_alg" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_hmac_alg \- HMAC algorithm
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_host_behavior_support" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_host_behavior_support" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_host_behavior_support \- Enable Advanced Command
.SH SYNOPSIS
-.TH "nvme_host_get_dhchap_key" 9 "nvme_host_get_dhchap_key" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_host_get_dhchap_key" 9 "nvme_host_get_dhchap_key" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_host_get_dhchap_key \- Return host key
.SH SYNOPSIS
-.TH "nvme_host_get_hostid" 9 "nvme_host_get_hostid" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_host_get_hostid" 9 "nvme_host_get_hostid" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_host_get_hostid \- Host ID of an nvme_host_t object
.SH SYNOPSIS
-.TH "nvme_host_get_hostnqn" 9 "nvme_host_get_hostnqn" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_host_get_hostnqn" 9 "nvme_host_get_hostnqn" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_host_get_hostnqn \- Host NQN of an nvme_host_t object
.SH SYNOPSIS
-.TH "nvme_host_get_hostsymname" 9 "nvme_host_get_hostsymname" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_host_get_hostsymname" 9 "nvme_host_get_hostsymname" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_host_get_hostsymname \- Get the host's symbolic name
.SH SYNOPSIS
-.TH "nvme_host_get_root" 9 "nvme_host_get_root" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_host_get_root" 9 "nvme_host_get_root" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_host_get_root \- Returns nvme_root_t object
.SH SYNOPSIS
-.TH "nvme_host_is_pdc_enabled" 9 "nvme_host_is_pdc_enabled" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_host_is_pdc_enabled" 9 "nvme_host_is_pdc_enabled" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_host_is_pdc_enabled \- Is Persistenct Discovery Controller enabled
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_host_mem_buf_attrs" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_host_mem_buf_attrs" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_host_mem_buf_attrs \- Host Memory Buffer - Attributes Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_host_metadata" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_host_metadata" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_host_metadata \- Host Metadata Data Structure
.SH SYNOPSIS
-.TH "nvme_host_release_fds" 9 "nvme_host_release_fds" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_host_release_fds" 9 "nvme_host_release_fds" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_host_release_fds \- Close all opened file descriptors under host
.SH SYNOPSIS
-.TH "nvme_host_set_dhchap_key" 9 "nvme_host_set_dhchap_key" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_host_set_dhchap_key" 9 "nvme_host_set_dhchap_key" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_host_set_dhchap_key \- set host key
.SH SYNOPSIS
-.TH "nvme_host_set_hostsymname" 9 "nvme_host_set_hostsymname" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_host_set_hostsymname" 9 "nvme_host_set_hostsymname" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_host_set_hostsymname \- Set the host's symbolic name
.SH SYNOPSIS
-.TH "nvme_host_set_pdc_enabled" 9 "nvme_host_set_pdc_enabled" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_host_set_pdc_enabled" 9 "nvme_host_set_pdc_enabled" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_host_set_pdc_enabled \- Set Persistent Discovery Controller flag
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_ctrl" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_ctrl" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_ctrl \- Identify Controller data structure
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_anacap" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_anacap" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_anacap \- This field indicates the capabilities associated with Asymmetric Namespace Access Reporting.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_apsta" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_apsta" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_apsta \- Flags indicating the attributes of the autonomous power state transition feature.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_avscc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_avscc" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_avscc \- Flags indicating the configuration settings for Admin Vendor Specific command handling.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_cmic" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_cmic" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_cmic \- Controller Multipath IO and Namespace Sharing Capabilities of the controller and NVM subsystem.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_cntrltype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_cntrltype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_cntrltype \- Controller types
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_cqes" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_cqes" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_cqes \- Defines the required and maximum Completion Queue entry size when using the NVM Command Set.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_ctratt" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_ctratt" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_ctratt \- Controller attributes
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_dctype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_dctype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_dctype \- Discovery Controller types
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_dsto" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_dsto" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_dsto \- Flags indicating the optional Device Self-test command or operation behaviors supported by the controller or NVM subsystem.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_fcatt" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_fcatt" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_fcatt \- This field indicates attributes of the controller that are specific to NVMe over Fabrics.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_fna" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_fna" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_fna \- This field indicates attributes for the Format NVM command.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_frmw" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_frmw" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_frmw \- Flags and values indicates capabilities regarding firmware updates from &struct nvme_id_ctrl.frmw.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_fuses" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_fuses" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_fuses \- This field indicates the fused operations that the controller supports.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_hctm" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_hctm" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_hctm \- Flags indicate the attributes of the host controlled thermal management feature
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_lpa" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_lpa" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_lpa \- Flags indicating optional attributes for log pages that are accessed via the Get Log Page command.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_mec" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_mec" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_mec \- Flags indicating the capabilities of the Management Endpoint in the Controller, &struct nvme_id_ctrl.mec.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_ctrl_nvm" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_ctrl_nvm" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_ctrl_nvm \- I/O Command Set Specific Identify Controller data structure
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_nvmsr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_nvmsr" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_nvmsr \- This field reports information associated with the NVM Subsystem, see &struct nvme_id_ctrl.nvmsr.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_nvscc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_nvscc" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_nvscc \- This field indicates the configuration settings for NVM Vendor Specific command handling.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_nwpc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_nwpc" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_nwpc \- This field indicates the optional namespace write protection capabilities supported by the controller.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_oacs" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_oacs" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_oacs \- Flags indicating the optional Admin commands and features supported by the controller, see &struct nvme_id_ctrl.oacs.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_oaes" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_oaes" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_oaes \- Optional Asynchronous Events Supported
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_ofcs" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_ofcs" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_ofcs \- Indicate whether the controller supports optional fabric commands.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_oncs" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_oncs" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_oncs \- This field indicates the optional NVM commands and features supported by the controller.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_rpmbs" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_rpmbs" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_rpmbs \- This field indicates if the controller supports one or more Replay Protected Memory Blocks, from &struct nvme_id_ctrl.rpmbs.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_sanicap" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_sanicap" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_sanicap \- Indicates attributes for sanitize operations.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_sgls" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_sgls" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_sgls \- This field indicates if SGLs are supported for the NVM Command Set and the particular SGL types supported.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_sqes" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_sqes" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_sqes \- Defines the required and maximum Submission Queue entry size when using the NVM Command Set.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_vwc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_vwc" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_vwc \- Volatile write cache
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ctrl_vwci" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_vwci" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ctrl_vwci \- This field indicates information about remaining number of times that VPD contents are able to be updated using the VPD Write command, see &struct nvme_id_ctrl.vwci.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_directives" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_directives" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_directives \- Identify Directive - Return Parameters Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_domain_attr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_domain_attr" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_domain_attr \- Domain Attributes Entry
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_domain_list" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_domain_list" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_domain_list \- Domain List
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_endurance_group_list" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_endurance_group_list" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_endurance_group_list \- Endurance Group List
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_independent_id_ns" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_independent_id_ns" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_independent_id_ns \- Identify - I/O Command Set Independent Identify Namespace Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_iocs" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_iocs" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_iocs \- NVMe Identify IO Command Set data structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_ns" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_ns" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_ns \- Identify Namespace data structure
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ns_attr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_attr" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ns_attr \- Specifies attributes of the namespace.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ns_dlfeat" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_dlfeat" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ns_dlfeat \- This field indicates information about features that affect deallocating logical blocks for this namespace.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ns_dpc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_dpc" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ns_dpc \- This field indicates the capabilities for the end-to-end data protection feature.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ns_dps" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_dps" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ns_dps \- This field indicates the Type settings for the end-to-end data protection feature.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ns_flbas" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_flbas" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ns_flbas \- This field indicates the LBA data size & metadata size combination that the namespace has been formatted with
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_ns_granularity_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_ns_granularity_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_ns_granularity_desc \- Namespace Granularity Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_ns_granularity_list" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_ns_granularity_list" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_ns_granularity_list \- Namespace Granularity List
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ns_mc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_mc" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ns_mc \- This field indicates the capabilities for metadata.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ns_nmic" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_nmic" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ns_nmic \- This field specifies multi-path I/O and namespace sharing capabilities of the namespace.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_ns_rescap" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_rescap" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_ns_rescap \- This field indicates the reservation capabilities of the namespace.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_nsfeat" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_nsfeat" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_nsfeat \- This field defines features of the namespace.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_nvmset_list" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_nvmset_list" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_nvmset_list \- NVM set list
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_psd" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_psd" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_psd \- Power Management data structure
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_id_uuid" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_uuid" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_id_uuid \- Identifier Association
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_uuid_list" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_uuid_list" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_uuid_list \- UUID list
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_id_uuid_list_entry" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_uuid_list_entry" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_id_uuid_list_entry \- UUID List Entry
.SH SYNOPSIS
-.TH "nvme_identify" 9 "nvme_identify" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify" 9 "nvme_identify" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify \- Send the NVMe Identify command
.SH SYNOPSIS
-.TH "nvme_identify_active_ns_list" 9 "nvme_identify_active_ns_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_active_ns_list" 9 "nvme_identify_active_ns_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_active_ns_list \- Retrieves active namespaces id list
.SH SYNOPSIS
-.TH "nvme_identify_active_ns_list_csi" 9 "nvme_identify_active_ns_list_csi" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_active_ns_list_csi" 9 "nvme_identify_active_ns_list_csi" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_active_ns_list_csi \- Active namespace ID list associated with a specified I/O command set
.SH SYNOPSIS
-.TH "nvme_identify_allocated_ns" 9 "nvme_identify_allocated_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_allocated_ns" 9 "nvme_identify_allocated_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_allocated_ns \- Same as nvme_identify_ns, but only for allocated namespaces
.SH SYNOPSIS
-.TH "nvme_identify_allocated_ns_list" 9 "nvme_identify_allocated_ns_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_allocated_ns_list" 9 "nvme_identify_allocated_ns_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_allocated_ns_list \- Retrieves allocated namespace id list
.SH SYNOPSIS
-.TH "nvme_identify_allocated_ns_list_csi" 9 "nvme_identify_allocated_ns_list_csi" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_allocated_ns_list_csi" 9 "nvme_identify_allocated_ns_list_csi" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_allocated_ns_list_csi \- Allocated namespace ID list associated with a specified I/O command set
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_identify_cns" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_identify_cns" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_identify_cns \- Identify - CNS Values
.SH SYNOPSIS
-.TH "nvme_identify_ctrl" 9 "nvme_identify_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_ctrl" 9 "nvme_identify_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_ctrl \- Retrieves nvme identify controller
.SH SYNOPSIS
-.TH "nvme_identify_ctrl_csi" 9 "nvme_identify_ctrl_csi" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_ctrl_csi" 9 "nvme_identify_ctrl_csi" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_ctrl_csi \- I/O command set specific Identify Controller data
.SH SYNOPSIS
-.TH "nvme_identify_ctrl_list" 9 "nvme_identify_ctrl_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_ctrl_list" 9 "nvme_identify_ctrl_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_ctrl_list \- Retrieves identify controller list
.SH SYNOPSIS
-.TH "nvme_identify_domain_list" 9 "nvme_identify_domain_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_domain_list" 9 "nvme_identify_domain_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_domain_list \- Domain list data
.SH SYNOPSIS
-.TH "nvme_identify_endurance_group_list" 9 "nvme_identify_endurance_group_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_endurance_group_list" 9 "nvme_identify_endurance_group_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_endurance_group_list \- Endurance group list data
.SH SYNOPSIS
-.TH "nvme_identify_independent_identify_ns" 9 "nvme_identify_independent_identify_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_independent_identify_ns" 9 "nvme_identify_independent_identify_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_independent_identify_ns \- I/O command set independent Identify namespace data
.SH SYNOPSIS
-.TH "nvme_identify_iocs" 9 "nvme_identify_iocs" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_iocs" 9 "nvme_identify_iocs" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_iocs \- I/O command set data structure
.SH SYNOPSIS
-.TH "nvme_identify_iocs_ns_csi_user_data_format" 9 "nvme_identify_iocs_ns_csi_user_data_format" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_iocs_ns_csi_user_data_format" 9 "nvme_identify_iocs_ns_csi_user_data_format" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_iocs_ns_csi_user_data_format \- Identify I/O command set namespace data structure
.SH SYNOPSIS
-.TH "nvme_identify_ns" 9 "nvme_identify_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_ns" 9 "nvme_identify_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_ns \- Retrieves nvme identify namespace
.SH SYNOPSIS
-.TH "nvme_identify_ns_csi" 9 "nvme_identify_ns_csi" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_ns_csi" 9 "nvme_identify_ns_csi" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_ns_csi \- I/O command set specific identify namespace data
.SH SYNOPSIS
-.TH "nvme_identify_ns_csi_user_data_format" 9 "nvme_identify_ns_csi_user_data_format" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_ns_csi_user_data_format" 9 "nvme_identify_ns_csi_user_data_format" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_ns_csi_user_data_format \- Identify namespace user data format
.SH SYNOPSIS
-.TH "nvme_identify_ns_descs" 9 "nvme_identify_ns_descs" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_ns_descs" 9 "nvme_identify_ns_descs" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_ns_descs \- Retrieves namespace descriptor list
.SH SYNOPSIS
-.TH "nvme_identify_ns_granularity" 9 "nvme_identify_ns_granularity" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_ns_granularity" 9 "nvme_identify_ns_granularity" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_ns_granularity \- Retrieves namespace granularity identification
.SH SYNOPSIS
-.TH "nvme_identify_nsid_ctrl_list" 9 "nvme_identify_nsid_ctrl_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_nsid_ctrl_list" 9 "nvme_identify_nsid_ctrl_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_nsid_ctrl_list \- Retrieves controller list attached to an nsid
.SH SYNOPSIS
-.TH "nvme_identify_nvmset_list" 9 "nvme_identify_nvmset_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_nvmset_list" 9 "nvme_identify_nvmset_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_nvmset_list \- Retrieves NVM Set List
.SH SYNOPSIS
-.TH "nvme_identify_primary_ctrl" 9 "nvme_identify_primary_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_primary_ctrl" 9 "nvme_identify_primary_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_primary_ctrl \- Retrieve NVMe Primary Controller identification
.SH SYNOPSIS
-.TH "nvme_identify_secondary_ctrl_list" 9 "nvme_identify_secondary_ctrl_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_secondary_ctrl_list" 9 "nvme_identify_secondary_ctrl_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_secondary_ctrl_list \- Retrieves secondary controller list
.SH SYNOPSIS
-.TH "nvme_identify_uuid" 9 "nvme_identify_uuid" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_identify_uuid" 9 "nvme_identify_uuid" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_identify_uuid \- Retrieves device's UUIDs
.SH SYNOPSIS
--- /dev/null
+.TH "nvme_import_tls_key" 9 "nvme_import_tls_key" "May 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_import_tls_key \- Import a TLS key
+.SH SYNOPSIS
+.B "unsigned char *" nvme_import_tls_key
+.BI "(const char *encoded_key " ","
+.BI "int *key_len " ","
+.BI "unsigned int *hmac " ");"
+.SH ARGUMENTS
+.IP "encoded_key" 12
+TLS key in PSK interchange format
+.IP "key_len" 12
+Length of the resulting key data
+.IP "hmac" 12
+HMAC algorithm
+.SH "DESCRIPTION"
+Imports \fIkey_data\fP in the PSK Interchange format as defined in section
+3.6.1.5 of the NVMe TCP Transport specification.
+.SH "RETURN"
+The raw data of the PSK or NULL with errno set on error. It is
+the responsibility of the caller to free the returned string.
-.TH "nvme_init_copy_range" 9 "nvme_init_copy_range" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_init_copy_range" 9 "nvme_init_copy_range" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_init_copy_range \- Constructs a copy range structure
.SH SYNOPSIS
-.TH "nvme_init_copy_range_f1" 9 "nvme_init_copy_range_f1" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_init_copy_range_f1" 9 "nvme_init_copy_range_f1" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_init_copy_range_f1 \- Constructs a copy range f1 structure
.SH SYNOPSIS
-.TH "nvme_init_copy_range_f2" 9 "nvme_init_copy_range_f2" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_init_copy_range_f2" 9 "nvme_init_copy_range_f2" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_init_copy_range_f2 \- Constructs a copy range f2 structure
.SH SYNOPSIS
-.TH "nvme_init_copy_range_f3" 9 "nvme_init_copy_range_f3" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_init_copy_range_f3" 9 "nvme_init_copy_range_f3" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_init_copy_range_f3 \- Constructs a copy range f3 structure
.SH SYNOPSIS
-.TH "nvme_init_ctrl" 9 "nvme_init_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_init_ctrl" 9 "nvme_init_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_init_ctrl \- Initialize nvme_ctrl_t object for an existing controller.
.SH SYNOPSIS
-.TH "nvme_init_ctrl_list" 9 "nvme_init_ctrl_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_init_ctrl_list" 9 "nvme_init_ctrl_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_init_ctrl_list \- Initialize an nvme_ctrl_list structure from an array.
.SH SYNOPSIS
-.TH "nvme_init_dsm_range" 9 "nvme_init_dsm_range" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_init_dsm_range" 9 "nvme_init_dsm_range" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_init_dsm_range \- Constructs a data set range structure
.SH SYNOPSIS
-.TH "nvme_init_logging" 9 "nvme_init_logging" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_init_logging" 9 "nvme_init_logging" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_init_logging \- Initialize logging
.SH SYNOPSIS
-.TH "nvme_insert_tls_key" 9 "nvme_insert_tls_key" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_insert_tls_key" 9 "nvme_insert_tls_key" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_insert_tls_key \- Derive and insert TLS key
.SH SYNOPSIS
-.TH "nvme_insert_tls_key_versioned" 9 "nvme_insert_tls_key_versioned" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_insert_tls_key_versioned" 9 "nvme_insert_tls_key_versioned" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_insert_tls_key_versioned \- Derive and insert TLS key
.SH SYNOPSIS
-.TH "nvme_io" 9 "nvme_io" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_io" 9 "nvme_io" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_io \- Submit an nvme user I/O command
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_io_control_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_io_control_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_io_control_flags \- I/O control flags
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_io_dsm_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_io_dsm_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_io_dsm_flags \- Dataset Management flags
.SH SYNOPSIS
-.TH "nvme_io_mgmt_recv" 9 "nvme_io_mgmt_recv" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_io_mgmt_recv" 9 "nvme_io_mgmt_recv" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_io_mgmt_recv \- I/O Management Receive command
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_io_mgmt_recv_mo" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_io_mgmt_recv_mo" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_io_mgmt_recv_mo \- I/O Management Receive - Management Operation
.SH SYNOPSIS
-.TH "nvme_io_mgmt_send" 9 "nvme_io_mgmt_send" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_io_mgmt_send" 9 "nvme_io_mgmt_send" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_io_mgmt_send \- I/O Management Send command
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_io_mgmt_send_mo" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_io_mgmt_send_mo" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_io_mgmt_send_mo \- I/O Management Send - Management Operation
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_io_opcode" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_io_opcode" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_io_opcode \- Opcodes for I/O Commands
.SH SYNOPSIS
-.TH "nvme_io_passthru" 9 "nvme_io_passthru" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_io_passthru" 9 "nvme_io_passthru" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_io_passthru \- Submit an nvme io passthrough command
.SH SYNOPSIS
-.TH "nvme_io_passthru64" 9 "nvme_io_passthru64" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_io_passthru64" 9 "nvme_io_passthru64" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_io_passthru64 \- Submit an nvme io passthrough command
.SH SYNOPSIS
-.TH "nvme_is_64bit_reg" 9 "nvme_is_64bit_reg" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_is_64bit_reg" 9 "nvme_is_64bit_reg" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_is_64bit_reg \- Checks if offset of the controller register is a know 64bit value.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_lba_range_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_range_type" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_lba_range_type \- LBA Range Type
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_lba_range_type_entry" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_range_type_entry" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_lba_range_type_entry \- LBA Range Type - Data Structure Entry
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_lba_rd" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_rd" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_lba_rd \- LBA Range Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_lba_status" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_status" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_lba_status \- LBA Status Descriptor List
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_lba_status_atype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_lba_status_atype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_lba_status_atype \- Potentially Unrecoverable LBAs
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_lba_status_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_status_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_lba_status_desc \- LBA Status Descriptor Entry
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_lba_status_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_status_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_lba_status_log \- LBA Status Information Log
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_lbaf" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lbaf" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_lbaf \- LBA Format Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_lbaf_rp" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_lbaf_rp" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_lbaf_rp \- This field indicates the relative performance of the LBA format indicated relative to other LBA formats supported by the controller.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_lbart" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_lbart" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_lbart \- LBA Range Type - Data Structure Entry
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_lbas_ns_element" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lbas_ns_element" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_lbas_ns_element \- LBA Status Log Namespace Element
.SH SYNOPSIS
-.TH "nvme_lockdown" 9 "nvme_lockdown" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_lockdown" 9 "nvme_lockdown" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_lockdown \- Issue lockdown command
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_log_ana_lsp" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_log_ana_lsp" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_log_ana_lsp \- Asymmetric Namespace Access - Return Groups Only
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_log_phy_rx_eom_action" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_log_phy_rx_eom_action" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_log_phy_rx_eom_action \- Physical Interface Receiver Eye Opening Measurement Action
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_log_phy_rx_eom_quality" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_log_phy_rx_eom_quality" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_log_phy_rx_eom_quality \- Physical Interface Receiver Eye Opening Measurement Quality
.SH SYNOPSIS
-.TH "nvme_lookup_ctrl" 9 "nvme_lookup_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_lookup_ctrl" 9 "nvme_lookup_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_lookup_ctrl \- Lookup nvme_ctrl_t object
.SH SYNOPSIS
-.TH "nvme_lookup_host" 9 "nvme_lookup_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_lookup_host" 9 "nvme_lookup_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_lookup_host \- Lookup nvme_host_t object
.SH SYNOPSIS
-.TH "nvme_lookup_key" 9 "nvme_lookup_key" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_lookup_key" 9 "nvme_lookup_key" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_lookup_key \- Lookup key serial number
.SH SYNOPSIS
-.TH "nvme_lookup_keyring" 9 "nvme_lookup_keyring" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_lookup_keyring" 9 "nvme_lookup_keyring" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_lookup_keyring \- Lookup keyring serial number
.SH SYNOPSIS
-.TH "nvme_lookup_subsystem" 9 "nvme_lookup_subsystem" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_lookup_subsystem" 9 "nvme_lookup_subsystem" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_lookup_subsystem \- Lookup nvme_subsystem_t object
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_media_unit_config_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_media_unit_config_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_media_unit_config_desc \- Media Unit Configuration Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_media_unit_stat_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_media_unit_stat_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_media_unit_stat_desc \- Media Unit Status Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_media_unit_stat_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_media_unit_stat_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_media_unit_stat_log \- Media Unit Status
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_metadata_element_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_metadata_element_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_metadata_element_desc \- Metadata Element Descriptor
.SH SYNOPSIS
-.TH "nvme_mi_admin_admin_passthru" 9 "nvme_mi_admin_admin_passthru" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_admin_passthru" 9 "nvme_mi_admin_admin_passthru" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_admin_passthru \- Submit an nvme admin passthrough command
.SH SYNOPSIS
-.TH "nvme_mi_admin_format_nvm" 9 "nvme_mi_admin_format_nvm" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_format_nvm" 9 "nvme_mi_admin_format_nvm" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_format_nvm \- Format NVMe namespace
.SH SYNOPSIS
-.TH "nvme_mi_admin_fw_commit" 9 "nvme_mi_admin_fw_commit" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_fw_commit" 9 "nvme_mi_admin_fw_commit" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_fw_commit \- Commit firmware using the specified action
.SH SYNOPSIS
-.TH "nvme_mi_admin_fw_download" 9 "nvme_mi_admin_fw_download" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_fw_download" 9 "nvme_mi_admin_fw_download" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_fw_download \- Download part or all of a firmware image to the controller
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_features_data" 9 "nvme_mi_admin_get_features_data" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_features_data" 9 "nvme_mi_admin_get_features_data" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_features_data \- Helper function for &nvme_mi_admin_get_features()
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log" 9 "nvme_mi_admin_get_log" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log" 9 "nvme_mi_admin_get_log" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log \- Retrieve log page data from controller
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_ana" 9 "nvme_mi_admin_get_log_ana" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_ana" 9 "nvme_mi_admin_get_log_ana" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_ana \- Retrieve Asymmetric Namespace Access log page
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_ana_groups" 9 "nvme_mi_admin_get_log_ana_groups" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_ana_groups" 9 "nvme_mi_admin_get_log_ana_groups" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_ana_groups \- Retrieve Asymmetric Namespace Access groups only log page
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_boot_partition" 9 "nvme_mi_admin_get_log_boot_partition" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_boot_partition" 9 "nvme_mi_admin_get_log_boot_partition" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_boot_partition \- Retrieve Boot Partition
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_changed_ns_list" 9 "nvme_mi_admin_get_log_changed_ns_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_changed_ns_list" 9 "nvme_mi_admin_get_log_changed_ns_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_changed_ns_list \- Retrieve namespace changed list
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_cmd_effects" 9 "nvme_mi_admin_get_log_cmd_effects" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_cmd_effects" 9 "nvme_mi_admin_get_log_cmd_effects" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_cmd_effects \- Retrieve nvme command effects log
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_create_telemetry_host" 9 "nvme_mi_admin_get_log_create_telemetry_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_create_telemetry_host" 9 "nvme_mi_admin_get_log_create_telemetry_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_create_telemetry_host \- Create host telemetry log
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_device_self_test" 9 "nvme_mi_admin_get_log_device_self_test" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_device_self_test" 9 "nvme_mi_admin_get_log_device_self_test" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_device_self_test \- Retrieve the device self test log
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_discovery" 9 "nvme_mi_admin_get_log_discovery" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_discovery" 9 "nvme_mi_admin_get_log_discovery" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_discovery \- Retrieve Discovery log page
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_endurance_group" 9 "nvme_mi_admin_get_log_endurance_group" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_endurance_group" 9 "nvme_mi_admin_get_log_endurance_group" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_endurance_group \- Get Endurance Group log
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_endurance_grp_evt" 9 "nvme_mi_admin_get_log_endurance_grp_evt" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_endurance_grp_evt" 9 "nvme_mi_admin_get_log_endurance_grp_evt" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_endurance_grp_evt \- Retrieve Rotational Media Information
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_error" 9 "nvme_mi_admin_get_log_error" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_error" 9 "nvme_mi_admin_get_log_error" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_error \- Retrieve nvme error log
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_fid_supported_effects" 9 "nvme_mi_admin_get_log_fid_supported_effects" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_fid_supported_effects" 9 "nvme_mi_admin_get_log_fid_supported_effects" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_fid_supported_effects \- Retrieve Feature Identifiers Supported and Effects
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_fw_slot" 9 "nvme_mi_admin_get_log_fw_slot" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_fw_slot" 9 "nvme_mi_admin_get_log_fw_slot" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_fw_slot \- Retrieves the controller firmware log
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_lba_status" 9 "nvme_mi_admin_get_log_lba_status" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_lba_status" 9 "nvme_mi_admin_get_log_lba_status" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_lba_status \- Retrieve LBA Status
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_media_unit_stat" 9 "nvme_mi_admin_get_log_media_unit_stat" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_media_unit_stat" 9 "nvme_mi_admin_get_log_media_unit_stat" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_media_unit_stat \- Retrieve Media Unit Status
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_mi_cmd_supported_effects" 9 "nvme_mi_admin_get_log_mi_cmd_supported_effects" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_mi_cmd_supported_effects" 9 "nvme_mi_admin_get_log_mi_cmd_supported_effects" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_mi_cmd_supported_effects \- displays the MI Commands Supported by the controller
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_page" 9 "nvme_mi_admin_get_log_page" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_page" 9 "nvme_mi_admin_get_log_page" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_page \- Retrieve log page data from controller
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_persistent_event" 9 "nvme_mi_admin_get_log_persistent_event" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_persistent_event" 9 "nvme_mi_admin_get_log_persistent_event" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_persistent_event \- Retrieve Persistent Event Log
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_phy_rx_eom" 9 "nvme_mi_admin_get_log_phy_rx_eom" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_phy_rx_eom" 9 "nvme_mi_admin_get_log_phy_rx_eom" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_phy_rx_eom \- Retrieve Physical Interface Receiver Eye Opening Measurement Log
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_predictable_lat_event" 9 "nvme_mi_admin_get_log_predictable_lat_event" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_predictable_lat_event" 9 "nvme_mi_admin_get_log_predictable_lat_event" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_predictable_lat_event \- Retrieve Predictable Latency Event Aggregate Log Page
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_predictable_lat_nvmset" 9 "nvme_mi_admin_get_log_predictable_lat_nvmset" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_predictable_lat_nvmset" 9 "nvme_mi_admin_get_log_predictable_lat_nvmset" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_predictable_lat_nvmset \- Predictable Latency Per NVM Set
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_reservation" 9 "nvme_mi_admin_get_log_reservation" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_reservation" 9 "nvme_mi_admin_get_log_reservation" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_reservation \- Retrieve Reservation Notification
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_sanitize" 9 "nvme_mi_admin_get_log_sanitize" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_sanitize" 9 "nvme_mi_admin_get_log_sanitize" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_sanitize \- Retrieve Sanitize Status
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_simple" 9 "nvme_mi_admin_get_log_simple" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_simple" 9 "nvme_mi_admin_get_log_simple" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_simple \- Helper for Get Log Page functions with no NSID or RAE requirements
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_smart" 9 "nvme_mi_admin_get_log_smart" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_smart" 9 "nvme_mi_admin_get_log_smart" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_smart \- Retrieve nvme smart log
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_support_cap_config_list" 9 "nvme_mi_admin_get_log_support_cap_config_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_support_cap_config_list" 9 "nvme_mi_admin_get_log_support_cap_config_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_support_cap_config_list \- Retrieve Supported Capacity Configuration List
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_supported_log_pages" 9 "nvme_mi_admin_get_log_supported_log_pages" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_supported_log_pages" 9 "nvme_mi_admin_get_log_supported_log_pages" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_supported_log_pages \- Retrieve nmve supported log pages
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_telemetry_ctrl" 9 "nvme_mi_admin_get_log_telemetry_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_telemetry_ctrl" 9 "nvme_mi_admin_get_log_telemetry_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_telemetry_ctrl \- Get Telemetry Controller-Initiated log page
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_telemetry_host" 9 "nvme_mi_admin_get_log_telemetry_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_telemetry_host" 9 "nvme_mi_admin_get_log_telemetry_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_telemetry_host \- Get Telemetry Host-Initiated log page
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_log_zns_changed_zones" 9 "nvme_mi_admin_get_log_zns_changed_zones" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log_zns_changed_zones" 9 "nvme_mi_admin_get_log_zns_changed_zones" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_log_zns_changed_zones \- Retrieve list of zones that have changed
.SH SYNOPSIS
-.TH "nvme_mi_admin_get_nsid_log" 9 "nvme_mi_admin_get_nsid_log" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_nsid_log" 9 "nvme_mi_admin_get_nsid_log" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_get_nsid_log \- Helper for Get Log Page functions
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify" 9 "nvme_mi_admin_identify" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify" 9 "nvme_mi_admin_identify" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify \- Perform an Admin identify command.
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_active_ns_list" 9 "nvme_mi_admin_identify_active_ns_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_active_ns_list" 9 "nvme_mi_admin_identify_active_ns_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_active_ns_list \- Perform an Admin identify for an active namespace list
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_allocated_ns" 9 "nvme_mi_admin_identify_allocated_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_allocated_ns" 9 "nvme_mi_admin_identify_allocated_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_allocated_ns \- Perform an Admin identify command for an allocated namespace
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_allocated_ns_list" 9 "nvme_mi_admin_identify_allocated_ns_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_allocated_ns_list" 9 "nvme_mi_admin_identify_allocated_ns_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_allocated_ns_list \- Perform an Admin identify for an allocated namespace list
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_cns_nsid" 9 "nvme_mi_admin_identify_cns_nsid" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_cns_nsid" 9 "nvme_mi_admin_identify_cns_nsid" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_cns_nsid \- Perform an Admin identify command using specific CNS/NSID parameters.
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_ctrl" 9 "nvme_mi_admin_identify_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_ctrl" 9 "nvme_mi_admin_identify_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_ctrl \- Perform an Admin identify for a controller
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_ctrl_list" 9 "nvme_mi_admin_identify_ctrl_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_ctrl_list" 9 "nvme_mi_admin_identify_ctrl_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_ctrl_list \- Perform an Admin identify for a controller list.
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_ns" 9 "nvme_mi_admin_identify_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_ns" 9 "nvme_mi_admin_identify_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_ns \- Perform an Admin identify command for a namespace
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_ns_descs" 9 "nvme_mi_admin_identify_ns_descs" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_ns_descs" 9 "nvme_mi_admin_identify_ns_descs" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_ns_descs \- Perform an Admin identify Namespace Identification Descriptor list command for a namespace
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_nsid_ctrl_list" 9 "nvme_mi_admin_identify_nsid_ctrl_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_nsid_ctrl_list" 9 "nvme_mi_admin_identify_nsid_ctrl_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_nsid_ctrl_list \- Perform an Admin identify for a controller list with specific namespace ID
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_partial" 9 "nvme_mi_admin_identify_partial" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_partial" 9 "nvme_mi_admin_identify_partial" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_partial \- Perform an Admin identify command, and retrieve partial response data.
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_primary_ctrl" 9 "nvme_mi_admin_identify_primary_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_primary_ctrl" 9 "nvme_mi_admin_identify_primary_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_primary_ctrl \- Perform an Admin identify for primary controller capabilities data structure.
.SH SYNOPSIS
-.TH "nvme_mi_admin_identify_secondary_ctrl_list" 9 "nvme_mi_admin_identify_secondary_ctrl_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_secondary_ctrl_list" 9 "nvme_mi_admin_identify_secondary_ctrl_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_identify_secondary_ctrl_list \- Perform an Admin identify for a secondary controller list.
.SH SYNOPSIS
-.TH "nvme_mi_admin_ns_attach" 9 "nvme_mi_admin_ns_attach" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_ns_attach" 9 "nvme_mi_admin_ns_attach" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_ns_attach \- Attach or detach namespace to controller(s)
.SH SYNOPSIS
-.TH "nvme_mi_admin_ns_attach_ctrls" 9 "nvme_mi_admin_ns_attach_ctrls" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_ns_attach_ctrls" 9 "nvme_mi_admin_ns_attach_ctrls" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_ns_attach_ctrls \- Attach namespace to controllers
.SH SYNOPSIS
-.TH "nvme_mi_admin_ns_detach_ctrls" 9 "nvme_mi_admin_ns_detach_ctrls" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_ns_detach_ctrls" 9 "nvme_mi_admin_ns_detach_ctrls" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_ns_detach_ctrls \- Detach namespace from controllers
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_admin_req_hdr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_admin_req_hdr" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_admin_req_hdr \- Admin command request header.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_admin_resp_hdr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_admin_resp_hdr" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_admin_resp_hdr \- Admin command response header.
.SH SYNOPSIS
-.TH "nvme_mi_admin_sanitize_nvm" 9 "nvme_mi_admin_sanitize_nvm" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_sanitize_nvm" 9 "nvme_mi_admin_sanitize_nvm" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_sanitize_nvm \- Start a subsystem Sanitize operation
.SH SYNOPSIS
-.TH "nvme_mi_admin_security_recv" 9 "nvme_mi_admin_security_recv" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_security_recv" 9 "nvme_mi_admin_security_recv" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_security_recv \- Perform a Security Receive command on a controller.
.SH SYNOPSIS
-.TH "nvme_mi_admin_security_send" 9 "nvme_mi_admin_security_send" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_security_send" 9 "nvme_mi_admin_security_send" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_security_send \- Perform a Security Send command on a controller.
.SH SYNOPSIS
-.TH "nvme_mi_admin_xfer" 9 "nvme_mi_admin_xfer" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_xfer" 9 "nvme_mi_admin_xfer" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_admin_xfer \- Raw admin transfer interface.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_ccs" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_ccs" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_ccs \- Get State Control Primitive Success Response Fields - Control Primitive Specific Response
.SH SYNOPSIS
-.TH "nvme_mi_close" 9 "nvme_mi_close" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_close" 9 "nvme_mi_close" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_close \- Close an endpoint connection and release resources, including controller objects.
.SH SYNOPSIS
-.TH "nvme_mi_close_ctrl" 9 "nvme_mi_close_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_close_ctrl" 9 "nvme_mi_close_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_close_ctrl \- free a controller
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_cmd_supported_effects" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_cmd_supported_effects" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_cmd_supported_effects \- MI Command Supported and Effects Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_cmd_supported_effects_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_cmd_supported_effects_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_cmd_supported_effects_log \- NVMe-MI Commands Supported and Effects Log
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_config_id" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_config_id" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_config_id \- NVMe-MI Configuration identifier.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_config_smbus_freq" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_config_smbus_freq" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_config_smbus_freq \- SMBus/I2C frequency values
.SH SYNOPSIS
-.TH "nvme_mi_create_root" 9 "nvme_mi_create_root" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_create_root" 9 "nvme_mi_create_root" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_create_root \- Create top-level MI (root) handle.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_csts" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_csts" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_csts \- Controller Health Data Structure (CHDS) - Controller Status (CSTS)
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_ctrl_health_status" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_ctrl_health_status" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_ctrl_health_status \- Controller Health Data Structure (CHDS)
.SH SYNOPSIS
-.TH "nvme_mi_ctrl_id" 9 "nvme_mi_ctrl_id" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_ctrl_id" 9 "nvme_mi_ctrl_id" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_ctrl_id \- get the ID of a controller
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_cwarn" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_cwarn" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_cwarn \- Controller Health Data Structure (CHDS) - Critical Warning (CWARN)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_dtyp" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_dtyp" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_dtyp \- Data Structure Type field.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_elem" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_elem" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_elem \- Element Descriptor Types
.SH SYNOPSIS
-.TH "nvme_mi_free_root" 9 "nvme_mi_free_root" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_free_root" 9 "nvme_mi_free_root" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_free_root \- Free root object.
.SH SYNOPSIS
-.TH "nvme_mi_init_ctrl" 9 "nvme_mi_init_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_init_ctrl" 9 "nvme_mi_init_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_init_ctrl \- initialise a NVMe controller.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_message_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_message_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_message_type \- NVMe-MI message type field.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_mi_opcode" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_mi_opcode" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_mi_opcode \- Operation code for supported NVMe-MI commands.
.SH SYNOPSIS
-.TH "nvme_mi_mi_read_mi_data_ctrl" 9 "nvme_mi_mi_read_mi_data_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_mi_read_mi_data_ctrl" 9 "nvme_mi_mi_read_mi_data_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_mi_read_mi_data_ctrl \- Perform a Read MI Data Structure command, retrieving controller information
.SH SYNOPSIS
-.TH "nvme_mi_mi_read_mi_data_ctrl_list" 9 "nvme_mi_mi_read_mi_data_ctrl_list" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_mi_read_mi_data_ctrl_list" 9 "nvme_mi_mi_read_mi_data_ctrl_list" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_mi_read_mi_data_ctrl_list \- Perform a Read MI Data Structure command, retrieving the list of attached controllers.
.SH SYNOPSIS
-.TH "nvme_mi_mi_read_mi_data_port" 9 "nvme_mi_mi_read_mi_data_port" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_mi_read_mi_data_port" 9 "nvme_mi_mi_read_mi_data_port" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_mi_read_mi_data_port \- Perform a Read MI Data Structure command, retrieving port data.
.SH SYNOPSIS
-.TH "nvme_mi_mi_read_mi_data_subsys" 9 "nvme_mi_mi_read_mi_data_subsys" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_mi_read_mi_data_subsys" 9 "nvme_mi_mi_read_mi_data_subsys" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_mi_read_mi_data_subsys \- Perform a Read MI Data Structure command, retrieving subsystem data.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_mi_req_hdr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_mi_req_hdr" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_mi_req_hdr \- MI request message header.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_mi_resp_hdr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_mi_resp_hdr" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_mi_resp_hdr \- MI response message header.
.SH SYNOPSIS
-.TH "nvme_mi_mi_subsystem_health_status_poll" 9 "nvme_mi_mi_subsystem_health_status_poll" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_mi_subsystem_health_status_poll" 9 "nvme_mi_mi_subsystem_health_status_poll" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_mi_subsystem_health_status_poll \- Read the Subsystem Health Data Structure from the NVM subsystem
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_msg_hdr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_msg_hdr" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_msg_hdr \- General MI message header.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_msg_resp" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_msg_resp" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_msg_resp \- Generic response type.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_nvm_ss_health_status" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_nvm_ss_health_status" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_nvm_ss_health_status \- Subsystem Management Data Structure
.SH SYNOPSIS
-.TH "nvme_mi_open_mctp" 9 "nvme_mi_open_mctp" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_open_mctp" 9 "nvme_mi_open_mctp" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_open_mctp \- Create an endpoint using a MCTP connection.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_osc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_osc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_osc \- Optionally Supported Command Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_port_pcie" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_port_pcie" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_port_pcie \- PCIe Port Specific Data
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_port_smb" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_port_smb" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_port_smb \- SMBus Port Specific Data
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_read_ctrl_info" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_read_ctrl_info" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_read_ctrl_info \- Controller Information Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_read_nvm_ss_info" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_read_nvm_ss_info" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_read_nvm_ss_info \- NVM Subsystem Information Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_read_port_info" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_read_port_info" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_read_port_info \- Port Information Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_read_sc_list" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_read_sc_list" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_read_sc_list \- Management Endpoint Buffer Supported Command List Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_mi_resp_status" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_resp_status" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_mi_resp_status \- values for the response status field
.SH SYNOPSIS
-.TH "nvme_mi_set_probe_enabled" 9 "nvme_mi_set_probe_enabled" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_set_probe_enabled" 9 "nvme_mi_set_probe_enabled" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_set_probe_enabled \- enable/disable the probe for new endpoints
.SH SYNOPSIS
-.TH "nvme_mi_status_to_string" 9 "nvme_mi_status_to_string" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_mi_status_to_string" 9 "nvme_mi_status_to_string" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_mi_status_to_string \- return a string representation of the MI status.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_vpd_hdr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_hdr" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_vpd_hdr \- Vital Product Data Common Header
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_vpd_mr_common" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_mr_common" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_vpd_mr_common \- NVMe MultiRecord Area
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_vpd_mra" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_mra" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_vpd_mra \- NVMe MultiRecord Area
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_vpd_ppmra" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_ppmra" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_vpd_ppmra \- NVMe PCIe Port MultiRecord Area
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_vpd_telem" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_telem" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_vpd_telem \- Vital Product Data Element Descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_mi_vpd_tra" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_tra" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_mi_vpd_tra \- Vital Product Data Topology MultiRecord
.SH SYNOPSIS
-.TH "nvme_namespace_attach_ctrls" 9 "nvme_namespace_attach_ctrls" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_namespace_attach_ctrls" 9 "nvme_namespace_attach_ctrls" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_namespace_attach_ctrls \- Attach namespace to controller(s)
.SH SYNOPSIS
-.TH "nvme_namespace_detach_ctrls" 9 "nvme_namespace_detach_ctrls" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_namespace_detach_ctrls" 9 "nvme_namespace_detach_ctrls" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_namespace_detach_ctrls \- Detach namespace from controller(s)
.SH SYNOPSIS
-.TH "nvme_namespace_filter" 9 "nvme_namespace_filter" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_namespace_filter" 9 "nvme_namespace_filter" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_namespace_filter \- Filter for namespaces
.SH SYNOPSIS
-.TH "nvme_namespace_first_path" 9 "nvme_namespace_first_path" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_namespace_first_path" 9 "nvme_namespace_first_path" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_namespace_first_path \- Start path iterator
.SH SYNOPSIS
-.TH "nvme_namespace_for_each_path" 9 "nvme_namespace_for_each_path" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_namespace_for_each_path" 9 "nvme_namespace_for_each_path" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_namespace_for_each_path \- Traverse paths
.SH SYNOPSIS
-.TH "nvme_namespace_for_each_path_safe" 9 "nvme_namespace_for_each_path_safe" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_namespace_for_each_path_safe" 9 "nvme_namespace_for_each_path_safe" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_namespace_for_each_path_safe \- Traverse paths
.SH SYNOPSIS
-.TH "nvme_namespace_next_path" 9 "nvme_namespace_next_path" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_namespace_next_path" 9 "nvme_namespace_next_path" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_namespace_next_path \- Next path iterator
.SH SYNOPSIS
-.TH "nvme_nbft_free" 9 "nvme_nbft_free" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_nbft_free" 9 "nvme_nbft_free" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_nbft_free \- Free the struct nbft_info and its contents
.SH SYNOPSIS
-.TH "nvme_nbft_read" 9 "nvme_nbft_read" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_nbft_read" 9 "nvme_nbft_read" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_nbft_read \- Read and parse contents of an ACPI NBFT table
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_nd_ns_fpi" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_nd_ns_fpi" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_nd_ns_fpi \- If a format operation is in progress, this field indicates the percentage of the namespace that remains to be formatted.
.SH SYNOPSIS
-.TH "nvme_next_host" 9 "nvme_next_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_next_host" 9 "nvme_next_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_next_host \- Next host iterator
.SH SYNOPSIS
-.TH "nvme_next_subsystem" 9 "nvme_next_subsystem" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_next_subsystem" 9 "nvme_next_subsystem" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_next_subsystem \- Next subsystem iterator
.SH SYNOPSIS
-.TH "nvme_ns_attach" 9 "nvme_ns_attach" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_attach" 9 "nvme_ns_attach" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_attach \- Attach or detach namespace to controller(s)
.SH SYNOPSIS
-.TH "nvme_ns_attach_ctrls" 9 "nvme_ns_attach_ctrls" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_attach_ctrls" 9 "nvme_ns_attach_ctrls" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_attach_ctrls \- Attach namespace to controllers
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ns_attach_sel" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ns_attach_sel" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ns_attach_sel \- Namespace Attachment - Select
.SH SYNOPSIS
-.TH "nvme_ns_compare" 9 "nvme_ns_compare" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_compare" 9 "nvme_ns_compare" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_compare \- Compare data on a namespace
.SH SYNOPSIS
-.TH "nvme_ns_detach_ctrls" 9 "nvme_ns_detach_ctrls" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_detach_ctrls" 9 "nvme_ns_detach_ctrls" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_detach_ctrls \- Detach namespace from controllers
.SH SYNOPSIS
-.TH "nvme_ns_flush" 9 "nvme_ns_flush" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_flush" 9 "nvme_ns_flush" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_flush \- Flush data to a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_csi" 9 "nvme_ns_get_csi" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_csi" 9 "nvme_ns_get_csi" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_csi \- Command set identifier of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_ctrl" 9 "nvme_ns_get_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_ctrl" 9 "nvme_ns_get_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_ctrl \- &nvme_ctrl_t of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_eui64" 9 "nvme_ns_get_eui64" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_eui64" 9 "nvme_ns_get_eui64" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_eui64 \- 64-bit eui of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_fd" 9 "nvme_ns_get_fd" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_fd" 9 "nvme_ns_get_fd" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_fd \- Get associated file descriptor
.SH SYNOPSIS
-.TH "nvme_ns_get_firmware" 9 "nvme_ns_get_firmware" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_firmware" 9 "nvme_ns_get_firmware" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_firmware \- Firmware string of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_generic_name" 9 "nvme_ns_get_generic_name" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_generic_name" 9 "nvme_ns_get_generic_name" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_generic_name \- Returns name of generic namespace chardev.
.SH SYNOPSIS
-.TH "nvme_ns_get_lba_count" 9 "nvme_ns_get_lba_count" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_lba_count" 9 "nvme_ns_get_lba_count" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_lba_count \- LBA count of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_lba_size" 9 "nvme_ns_get_lba_size" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_lba_size" 9 "nvme_ns_get_lba_size" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_lba_size \- LBA size of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_lba_util" 9 "nvme_ns_get_lba_util" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_lba_util" 9 "nvme_ns_get_lba_util" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_lba_util \- LBA utilization of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_meta_size" 9 "nvme_ns_get_meta_size" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_meta_size" 9 "nvme_ns_get_meta_size" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_meta_size \- Metadata size of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_model" 9 "nvme_ns_get_model" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_model" 9 "nvme_ns_get_model" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_model \- Model of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_name" 9 "nvme_ns_get_name" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_name" 9 "nvme_ns_get_name" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_name \- sysfs name of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_nguid" 9 "nvme_ns_get_nguid" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_nguid" 9 "nvme_ns_get_nguid" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_nguid \- 128-bit nguid of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_nsid" 9 "nvme_ns_get_nsid" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_nsid" 9 "nvme_ns_get_nsid" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_nsid \- NSID of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_serial" 9 "nvme_ns_get_serial" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_serial" 9 "nvme_ns_get_serial" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_serial \- Serial number of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_subsystem" 9 "nvme_ns_get_subsystem" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_subsystem" 9 "nvme_ns_get_subsystem" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_subsystem \- &nvme_subsystem_t of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_sysfs_dir" 9 "nvme_ns_get_sysfs_dir" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_sysfs_dir" 9 "nvme_ns_get_sysfs_dir" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_sysfs_dir \- sysfs directory of a namespace
.SH SYNOPSIS
-.TH "nvme_ns_get_uuid" 9 "nvme_ns_get_uuid" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_get_uuid" 9 "nvme_ns_get_uuid" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_get_uuid \- UUID of a namespace
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_ns_id_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ns_id_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_ns_id_desc \- Namespace identifier type descriptor
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ns_id_desc_nidt" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ns_id_desc_nidt" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ns_id_desc_nidt \- Known namespace identifier types
.SH SYNOPSIS
-.TH "nvme_ns_identify" 9 "nvme_ns_identify" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_identify" 9 "nvme_ns_identify" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_identify \- Issue an 'identify namespace' command
.SH SYNOPSIS
-.TH "nvme_ns_identify_descs" 9 "nvme_ns_identify_descs" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_identify_descs" 9 "nvme_ns_identify_descs" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_identify_descs \- Issue an 'identify descriptors' command
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_ns_list" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ns_list" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_ns_list \- Namespace List
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ns_metadata_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ns_metadata_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ns_metadata_type \- Namespace Metadata Element Types
.SH SYNOPSIS
-.TH "nvme_ns_mgmt" 9 "nvme_ns_mgmt" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_mgmt" 9 "nvme_ns_mgmt" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_mgmt \- Issue a Namespace management command
.SH SYNOPSIS
-.TH "nvme_ns_mgmt_create" 9 "nvme_ns_mgmt_create" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_mgmt_create" 9 "nvme_ns_mgmt_create" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_mgmt_create \- Create a non attached namespace
.SH SYNOPSIS
-.TH "nvme_ns_mgmt_delete" 9 "nvme_ns_mgmt_delete" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_mgmt_delete" 9 "nvme_ns_mgmt_delete" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_mgmt_delete \- Delete a non attached namespace
.SH SYNOPSIS
--- /dev/null
+.TH "nvme_ns_mgmt_delete_timeout" 9 "nvme_ns_mgmt_delete_timeout" "May 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_ns_mgmt_delete_timeout \- Delete a non attached namespace with timeout
+.SH SYNOPSIS
+.B "int" nvme_ns_mgmt_delete_timeout
+.BI "(int fd " ","
+.BI "__u32 nsid " ","
+.BI "__u32 timeout " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "nsid" 12
+Namespace identifier to delete
+.IP "timeout" 12
+Override the default timeout to this value in milliseconds;
+set to 0 to use the system default.
+.SH "DESCRIPTION"
+It is recommended that a namespace being deleted is not attached to any
+controller. Use the \fBnvme_ns_detach_ctrls\fP first if the namespace is still
+attached.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
-.TH "libnvme" 9 "struct nvme_ns_mgmt_host_sw_specified" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ns_mgmt_host_sw_specified" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_ns_mgmt_host_sw_specified \- Namespace management Host Software Specified Fields.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ns_mgmt_sel" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ns_mgmt_sel" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ns_mgmt_sel \- Namespace Management - Select
.SH SYNOPSIS
-.TH "nvme_ns_read" 9 "nvme_ns_read" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_read" 9 "nvme_ns_read" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_read \- Read from a namespace
.SH SYNOPSIS
-.TH "nvme_ns_release_fd" 9 "nvme_ns_release_fd" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_release_fd" 9 "nvme_ns_release_fd" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_release_fd \- Close fd and clear fd from ns object
.SH SYNOPSIS
-.TH "nvme_ns_rescan" 9 "nvme_ns_rescan" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_rescan" 9 "nvme_ns_rescan" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_rescan \- Initiate a controller rescan
.SH SYNOPSIS
-.TH "nvme_ns_verify" 9 "nvme_ns_verify" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_verify" 9 "nvme_ns_verify" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_verify \- Verify data on a namespace
.SH SYNOPSIS
-.TH "nvme_ns_write" 9 "nvme_ns_write" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_write" 9 "nvme_ns_write" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_write \- Write to a namespace
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_ns_write_protect_cfg" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ns_write_protect_cfg" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_ns_write_protect_cfg \- Write Protection - Write Protection State
.SH SYNOPSIS
-.TH "nvme_ns_write_uncorrectable" 9 "nvme_ns_write_uncorrectable" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_write_uncorrectable" 9 "nvme_ns_write_uncorrectable" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_write_uncorrectable \- Issus a 'write uncorrectable' command
.SH SYNOPSIS
-.TH "nvme_ns_write_zeros" 9 "nvme_ns_write_zeros" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_ns_write_zeros" 9 "nvme_ns_write_zeros" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_ns_write_zeros \- Write zeros to a namespace
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_nss_hw_err_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_nss_hw_err_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_nss_hw_err_event \- NVM Subsystem Hardware Error Event
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_nvm_id_ns" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_nvm_id_ns" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_nvm_id_ns \- NVME Command Set I/O Command Set Specific Identify Namespace Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_nvm_id_ns_elbaf" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_nvm_id_ns_elbaf" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_nvm_id_ns_elbaf \- This field indicates the extended LBA format
.SH SYNOPSIS
-.TH "nvme_nvm_identify_ctrl" 9 "nvme_nvm_identify_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_nvm_identify_ctrl" 9 "nvme_nvm_identify_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_nvm_identify_ctrl \- Identify controller data
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_nvmeset_pl_status" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_nvmeset_pl_status" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_nvmeset_pl_status \- Predictable Latency Per NVM Set Log - Status
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_nvmset_attr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_nvmset_attr" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_nvmset_attr \- NVM Set Attributes Entry
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_nvmset_pl_events" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_nvmset_pl_events" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_nvmset_pl_events \- Predictable Latency Per NVM Set Log - Event Type
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_nvmset_predictable_lat_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_nvmset_predictable_lat_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_nvmset_predictable_lat_log \- Predictable Latency Mode - Deterministic Threshold Configuration Data
.SH SYNOPSIS
-.TH "nvme_open" 9 "nvme_open" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_open" 9 "nvme_open" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_open \- Open an nvme controller or namespace device
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_passthru_cmd" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_passthru_cmd" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_passthru_cmd \- nvme passthrough command structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_passthru_cmd64" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_passthru_cmd64" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_passthru_cmd64 \- 64-bit nvme passthrough command structure
.SH SYNOPSIS
-.TH "nvme_path_get_ana_state" 9 "nvme_path_get_ana_state" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_path_get_ana_state" 9 "nvme_path_get_ana_state" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_path_get_ana_state \- ANA state of an nvme_path_t object
.SH SYNOPSIS
-.TH "nvme_path_get_ctrl" 9 "nvme_path_get_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_path_get_ctrl" 9 "nvme_path_get_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_path_get_ctrl \- Parent controller of an nvme_path_t object
.SH SYNOPSIS
-.TH "nvme_path_get_name" 9 "nvme_path_get_name" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_path_get_name" 9 "nvme_path_get_name" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_path_get_name \- sysfs name of an &nvme_path_t object
.SH SYNOPSIS
-.TH "nvme_path_get_ns" 9 "nvme_path_get_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_path_get_ns" 9 "nvme_path_get_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_path_get_ns \- Parent namespace of an nvme_path_t object
.SH SYNOPSIS
-.TH "nvme_path_get_sysfs_dir" 9 "nvme_path_get_sysfs_dir" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_path_get_sysfs_dir" 9 "nvme_path_get_sysfs_dir" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_path_get_sysfs_dir \- sysfs directory of an nvme_path_t object
.SH SYNOPSIS
-.TH "nvme_paths_filter" 9 "nvme_paths_filter" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_paths_filter" 9 "nvme_paths_filter" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_paths_filter \- Filter for paths
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_pel_ehai" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_pel_ehai \- This field indicates the persistent event header additional information
+.SH SYNOPSIS
+enum nvme_pel_ehai {
+.br
+.BI " NVME_PEL_EHAI_PIT_SHIFT"
+,
+.br
+.br
+.BI " NVME_PEL_EHAI_RSVD_SHIFT"
+,
+.br
+.br
+.BI " NVME_PEL_EHAI_PIT_MASK"
+,
+.br
+.br
+.BI " NVME_PEL_EHAI_RSVD_MASK"
+
+};
+.SH Constants
+.IP "NVME_PEL_EHAI_PIT_SHIFT" 12
+Shift amount to get the reporting context port identifier
+from the \fIstruct nvme_persistent_event_log\fP.rci field.
+.IP "NVME_PEL_EHAI_RSVD_SHIFT" 12
+Shift amount to get the reserved reporting context
+from the \fIstruct nvme_persistent_event_log\fP.rci field.
+.IP "NVME_PEL_EHAI_PIT_MASK" 12
+Mask to get the reporting context port identifier from
+the \fIstruct nvme_st_result\fP.dsts field.
+.IP "NVME_PEL_EHAI_RSVD_MASK" 12
+Mask to get the reserved reporting context from
+the \fIstruct nvme_st_result\fP.dsts field.
--- /dev/null
+.TH "libnvme" 9 "enum nvme_pel_ehai_pit" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_pel_ehai_pit \- Persistent Event Header Additional Information - Port Identifier Type
+.SH SYNOPSIS
+enum nvme_pel_ehai_pit {
+.br
+.BI " NVME_PEL_EHAI_PIT_NOT_REPORTED"
+,
+.br
+.br
+.BI " NVME_PEL_EHAI_PIT_NSS_PORT"
+,
+.br
+.br
+.BI " NVME_PEL_EHAI_PIT_NMI_PORT"
+,
+.br
+.br
+.BI " NVME_PEL_EHAI_PIT_NOT_ASSOCIATED"
+
+};
+.SH Constants
+.IP "NVME_PEL_EHAI_PIT_NOT_REPORTED" 12
+PIT not reported and PELPID does not apply
+.IP "NVME_PEL_EHAI_PIT_NSS_PORT" 12
+NVM subsystem port
+.IP "NVME_PEL_EHAI_PIT_NMI_PORT" 12
+NVMe-MI port
+.IP "NVME_PEL_EHAI_PIT_NOT_ASSOCIATED" 12
+Event not associated with any port and PELPID does not apply
--- /dev/null
+.TH "libnvme" 9 "enum nvme_pel_rci" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_pel_rci \- This field indicates the persistent event log reporting context
+.SH SYNOPSIS
+enum nvme_pel_rci {
+.br
+.BI " NVME_PEL_RCI_RCPID_SHIFT"
+,
+.br
+.br
+.BI " NVME_PEL_RCI_RCPIT_SHIFT"
+,
+.br
+.br
+.BI " NVME_PEL_RCI_RCE_SHIFT"
+,
+.br
+.br
+.BI " NVME_PEL_RCI_RSVD_SHIFT"
+,
+.br
+.br
+.BI " NVME_PEL_RCI_RCPID_MASK"
+,
+.br
+.br
+.BI " NVME_PEL_RCI_RCPIT_MASK"
+,
+.br
+.br
+.BI " NVME_PEL_RCI_RCE_MASK"
+,
+.br
+.br
+.BI " NVME_PEL_RCI_RSVD_MASK"
+
+};
+.SH Constants
+.IP "NVME_PEL_RCI_RCPID_SHIFT" 12
+Shift amount to get the reporting context port identifier
+from the \fIstruct nvme_persistent_event_log\fP.rci field.
+.IP "NVME_PEL_RCI_RCPIT_SHIFT" 12
+Shift amount to get the reporting context port identifier
+type from the \fIstruct nvme_persistent_event_log\fP.rci field.
+.IP "NVME_PEL_RCI_RCE_SHIFT" 12
+Shift amount to get the reporting context exists
+from the \fIstruct nvme_persistent_event_log\fP.rci field.
+.IP "NVME_PEL_RCI_RSVD_SHIFT" 12
+Shift amount to get the reserved reporting context
+from the \fIstruct nvme_persistent_event_log\fP.rci field.
+.IP "NVME_PEL_RCI_RCPID_MASK" 12
+Mask to get the reporting context port identifier from
+the \fIstruct nvme_persistent_event_log\fP.rci field.
+.IP "NVME_PEL_RCI_RCPIT_MASK" 12
+Mask to get the reporting context port identifier type from
+the \fIstruct nvme_persistent_event_log\fP.rci field.
+.IP "NVME_PEL_RCI_RCE_MASK" 12
+Mask to get the reporting context exists from
+the \fIstruct nvme_persistent_event_log\fP.rci field.
+.IP "NVME_PEL_RCI_RSVD_MASK" 12
+Mask to get the reserved reporting context from
+the \fIstruct nvme_persistent_event_log\fP.rci field.
--- /dev/null
+.TH "libnvme" 9 "enum nvme_pel_rci_rcpit" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_pel_rci_rcpit \- Persistent Event Log Reporting Context - Port Identifier Type
+.SH SYNOPSIS
+enum nvme_pel_rci_rcpit {
+.br
+.BI " NVME_PEL_RCI_RCPIT_NOT_EXIST"
+,
+.br
+.br
+.BI " NVME_PEL_RCI_RCPIT_EST_PORT"
+,
+.br
+.br
+.BI " NVME_PEL_RCI_RCPIT_EST_ME"
+
+};
+.SH Constants
+.IP "NVME_PEL_RCI_RCPIT_NOT_EXIST" 12
+Does not already exist
+.IP "NVME_PEL_RCI_RCPIT_EST_PORT" 12
+Established by an NVM subsystem port
+.IP "NVME_PEL_RCI_RCPIT_EST_ME" 12
+Established by a Management Endpoint
-.TH "libnvme" 9 "struct nvme_persistent_event_entry" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_persistent_event_entry" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_persistent_event_entry \- Persistent Event
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_persistent_event_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_persistent_event_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_persistent_event_log \- Persistent Event Log
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_persistent_event_types" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_persistent_event_types" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_persistent_event_types \- Persistent event log events
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_pevent_log_action" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_pevent_log_action" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_pevent_log_action \- Persistent Event Log - Action
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_phy_rx_eom_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_phy_rx_eom_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_phy_rx_eom_log \- Physical Interface Receiver Eye Opening Measurement Log
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_phy_rx_eom_progress" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_phy_rx_eom_progress" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_phy_rx_eom_progress \- EOM In Progress Values
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_plm_config" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_plm_config" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_plm_config \- Predictable Latency Mode - Deterministic Threshold Configuration Data Structure
.SH SYNOPSIS
-.TH "nvme_pmr_size" 9 "nvme_pmr_size" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_pmr_size" 9 "nvme_pmr_size" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_pmr_size \- Calculate size of persistent memory region elasticity buffer
.SH SYNOPSIS
-.TH "nvme_pmr_throughput" 9 "nvme_pmr_throughput" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_pmr_throughput" 9 "nvme_pmr_throughput" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_pmr_throughput \- Calculate throughput of persistent memory buffer
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_pmrcap" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_pmrcap \- This field indicates the persistent memory region capabilities
+.SH SYNOPSIS
+enum nvme_pmrcap {
+.br
+.BI " NVME_PMRCAP_RDS_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRCAP_WDS_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRCAP_BIR_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRCAP_PMRTU_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRCAP_PMRWBM_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRCAP_PMRTO_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRCAP_CMSS_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRCAP_PMRWMB_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRCAP_RDS_MASK"
+,
+.br
+.br
+.BI " NVME_PMRCAP_WDS_MASK"
+,
+.br
+.br
+.BI " NVME_PMRCAP_BIR_MASK"
+,
+.br
+.br
+.BI " NVME_PMRCAP_PMRTU_MASK"
+,
+.br
+.br
+.BI " NVME_PMRCAP_PMRWBM_MASK"
+,
+.br
+.br
+.BI " NVME_PMRCAP_PMRTO_MASK"
+,
+.br
+.br
+.BI " NVME_PMRCAP_CMSS_MASK"
+,
+.br
+.br
+.BI " NVME_PMRCAP_PMRWMB_MASK"
+,
+.br
+.br
+.BI " NVME_PMRCAP_PMRTU_500MS"
+,
+.br
+.br
+.BI " NVME_PMRCAP_PMRTU_60S"
+
+};
+.SH Constants
+.IP "NVME_PMRCAP_RDS_SHIFT" 12
+Shift amount to get the read data support
+.IP "NVME_PMRCAP_WDS_SHIFT" 12
+Shift amount to get the write data support
+.IP "NVME_PMRCAP_BIR_SHIFT" 12
+Shift amount to get the base indicator register
+.IP "NVME_PMRCAP_PMRTU_SHIFT" 12
+Shift amount to get the persistent memory region time units
+.IP "NVME_PMRCAP_PMRWBM_SHIFT" 12
+Shift amount to get the persistent memory region write barrier mechanisms
+.IP "NVME_PMRCAP_PMRTO_SHIFT" 12
+Shift amount to get the persistent memory region timeout
+.IP "NVME_PMRCAP_CMSS_SHIFT" 12
+Shift amount to get the controller memory space supported
+.IP "NVME_PMRCAP_PMRWMB_SHIFT" 12
+Deprecated shift amount to get the persistent memory region write barrier mechanisms
+.IP "NVME_PMRCAP_RDS_MASK" 12
+Mask to get the read data support
+.IP "NVME_PMRCAP_WDS_MASK" 12
+Mask to get the write data support
+.IP "NVME_PMRCAP_BIR_MASK" 12
+Mask to get the base indicator register
+.IP "NVME_PMRCAP_PMRTU_MASK" 12
+Mask to get the persistent memory region time units
+.IP "NVME_PMRCAP_PMRWBM_MASK" 12
+Mask to get the persistent memory region write barrier mechanisms
+.IP "NVME_PMRCAP_PMRTO_MASK" 12
+Mask to get the persistent memory region timeout
+.IP "NVME_PMRCAP_CMSS_MASK" 12
+Mask to get the controller memory space supported
+.IP "NVME_PMRCAP_PMRWMB_MASK" 12
+Deprecated mask to get the persistent memory region write barrier mechanisms
+.IP "NVME_PMRCAP_PMRTU_500MS" 12
+500 milliseconds
+.IP "NVME_PMRCAP_PMRTU_60S" 12
+minutes
--- /dev/null
+.TH "libnvme" 9 "enum nvme_pmrctl" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_pmrctl \- This field indicates the persistent memory region control
+.SH SYNOPSIS
+enum nvme_pmrctl {
+.br
+.BI " NVME_PMRCTL_EN_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRCTL_EN_MASK"
+
+};
+.SH Constants
+.IP "NVME_PMRCTL_EN_SHIFT" 12
+Shift amount to get the enable
+.IP "NVME_PMRCTL_EN_MASK" 12
+Mask to get the enable
--- /dev/null
+.TH "libnvme" 9 "enum nvme_pmrebs" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_pmrebs \- This field indicates the persistent memory region elasticity buffer size
+.SH SYNOPSIS
+enum nvme_pmrebs {
+.br
+.BI " NVME_PMREBS_PMRSZU_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMREBS_RBB_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMREBS_PMRWBZ_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMREBS_PMRSZU_MASK"
+,
+.br
+.br
+.BI " NVME_PMREBS_RBB_MASK"
+,
+.br
+.br
+.BI " NVME_PMREBS_PMRWBZ_MASK"
+,
+.br
+.br
+.BI " NVME_PMREBS_PMRSZU_B"
+,
+.br
+.br
+.BI " NVME_PMREBS_PMRSZU_1K"
+,
+.br
+.br
+.BI " NVME_PMREBS_PMRSZU_1M"
+,
+.br
+.br
+.BI " NVME_PMREBS_PMRSZU_1G"
+
+};
+.SH Constants
+.IP "NVME_PMREBS_PMRSZU_SHIFT" 12
+Shift amount to get the PMR elasticity buffer size units
+.IP "NVME_PMREBS_RBB_SHIFT" 12
+Shift amount to get the read bypass behavior
+.IP "NVME_PMREBS_PMRWBZ_SHIFT" 12
+Shift amount to get the PMR elasticity buffer size base
+.IP "NVME_PMREBS_PMRSZU_MASK" 12
+Mask to get the PMR elasticity buffer size units
+.IP "NVME_PMREBS_RBB_MASK" 12
+Mask to get the read bypass behavior
+.IP "NVME_PMREBS_PMRWBZ_MASK" 12
+Mask to get the PMR elasticity buffer size base
+.IP "NVME_PMREBS_PMRSZU_B" 12
+Bytes
+.IP "NVME_PMREBS_PMRSZU_1K" 12
+1 KiB
+.IP "NVME_PMREBS_PMRSZU_1M" 12
+1 MiB
+.IP "NVME_PMREBS_PMRSZU_1G" 12
+1 GiB
--- /dev/null
+.TH "libnvme" 9 "enum nvme_pmrmsc" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_pmrmsc \- This field indicates the persistent memory region memory space control
+.SH SYNOPSIS
+enum nvme_pmrmsc {
+.br
+.BI " NVME_PMRMSC_CMSE_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRMSC_CBA_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRMSC_CMSE_MASK"
+
+};
+.SH Constants
+.IP "NVME_PMRMSC_CMSE_SHIFT" 12
+Shift amount to get the controller memory space enable
+.IP "NVME_PMRMSC_CBA_SHIFT" 12
+Shift amount to get the controller base address
+.IP "NVME_PMRMSC_CMSE_MASK" 12
+Mask to get the controller memory space enable
--- /dev/null
+.TH "libnvme" 9 "enum nvme_pmrsts" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_pmrsts \- This field indicates the persistent memory region status
+.SH SYNOPSIS
+enum nvme_pmrsts {
+.br
+.BI " NVME_PMRSTS_ERR_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRSTS_NRDY_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRSTS_HSTS_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRSTS_CBAI_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRSTS_ERR_MASK"
+,
+.br
+.br
+.BI " NVME_PMRSTS_NRDY_MASK"
+,
+.br
+.br
+.BI " NVME_PMRSTS_HSTS_MASK"
+,
+.br
+.br
+.BI " NVME_PMRSTS_CBAI_MASK"
+
+};
+.SH Constants
+.IP "NVME_PMRSTS_ERR_SHIFT" 12
+Shift amount to get the error
+.IP "NVME_PMRSTS_NRDY_SHIFT" 12
+Shift amount to get the not ready
+.IP "NVME_PMRSTS_HSTS_SHIFT" 12
+Shift amount to get the health status
+.IP "NVME_PMRSTS_CBAI_SHIFT" 12
+Shift amount to get the controller base address invalid
+.IP "NVME_PMRSTS_ERR_MASK" 12
+Mask to get the error
+.IP "NVME_PMRSTS_NRDY_MASK" 12
+Mask to get the not ready
+.IP "NVME_PMRSTS_HSTS_MASK" 12
+Mask to get the health status
+.IP "NVME_PMRSTS_CBAI_MASK" 12
+Mask to get the controller base address invalid
--- /dev/null
+.TH "libnvme" 9 "enum nvme_pmrswtp" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_pmrswtp \- This field indicates the persistent memory region sustained write throughput
+.SH SYNOPSIS
+enum nvme_pmrswtp {
+.br
+.BI " NVME_PMRSWTP_PMRSWTU_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRSWTP_PMRSWTV_SHIFT"
+,
+.br
+.br
+.BI " NVME_PMRSWTP_PMRSWTU_MASK"
+,
+.br
+.br
+.BI " NVME_PMRSWTP_PMRSWTV_MASK"
+,
+.br
+.br
+.BI " NVME_PMRSWTP_PMRSWTU_BPS"
+,
+.br
+.br
+.BI " NVME_PMRSWTP_PMRSWTU_KBPS"
+,
+.br
+.br
+.BI " NVME_PMRSWTP_PMRSWTU_MBPS"
+,
+.br
+.br
+.BI " NVME_PMRSWTP_PMRSWTU_GBPS"
+
+};
+.SH Constants
+.IP "NVME_PMRSWTP_PMRSWTU_SHIFT" 12
+Shift amount to get the PMR sustained write throughput units
+.IP "NVME_PMRSWTP_PMRSWTV_SHIFT" 12
+Shift amount to get the PMR sustained write throughput
+.IP "NVME_PMRSWTP_PMRSWTU_MASK" 12
+Mask to get the PMR sustained write throughput units
+.IP "NVME_PMRSWTP_PMRSWTV_MASK" 12
+Mask to get the PMR sustained write throughput
+.IP "NVME_PMRSWTP_PMRSWTU_BPS" 12
+Bytes per second
+.IP "NVME_PMRSWTP_PMRSWTU_KBPS" 12
+1 KiB / s
+.IP "NVME_PMRSWTP_PMRSWTU_MBPS" 12
+1 MiB / s
+.IP "NVME_PMRSWTP_PMRSWTU_GBPS" 12
+1 GiB / s
-.TH "libnvme" 9 "struct nvme_power_on_reset_info_list" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_power_on_reset_info_list" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_power_on_reset_info_list \- Controller Reset Information
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_primary_ctrl_cap" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_primary_ctrl_cap" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_primary_ctrl_cap \- Identify - Controller Capabilities Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_psd_flags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_psd_flags" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_psd_flags \- Possible flag values in nvme power state descriptor
.SH SYNOPSIS
-.TH "nvme_psd_power_scale" 9 "nvme_psd_power_scale" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_psd_power_scale" 9 "nvme_psd_power_scale" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_psd_power_scale \- power scale occupies the upper 3 bits
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_psd_ps" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_psd_ps" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_psd_ps \- Known values for &struct nvme_psd %ips and %aps. Use with nvme_psd_power_scale() to extract the power scale field to match this enum.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_psd_workload" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_psd_workload" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_psd_workload \- Specifies a workload hint in the Power Management Feature (see &struct nvme_psd.apw) to inform the NVM subsystem or indicate the conditions for the active power level.
.SH SYNOPSIS
-.TH "nvme_read" 9 "nvme_read" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_read" 9 "nvme_read" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_read \- Submit an nvme user read command
.SH SYNOPSIS
-.TH "nvme_read_config" 9 "nvme_read_config" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_read_config" 9 "nvme_read_config" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_read_config \- Read NVMe JSON configuration file
.SH SYNOPSIS
--- /dev/null
+.TH "nvme_read_key" 9 "nvme_read_key" "May 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_read_key \- Read key raw data
+.SH SYNOPSIS
+.B "unsigned char *" nvme_read_key
+.BI "(long keyring_id " ","
+.BI "long key_id " ","
+.BI "int *len " ");"
+.SH ARGUMENTS
+.IP "keyring_id" 12
+Id of the keyring holding key_id
+.IP "key_id" 12
+Key id
+.IP "len" 12
+Length of the returned data
+.SH "DESCRIPTION"
+Links the keyring specified by \fIkeyring_id\fP into the session
+keyring and reads the payload of the key specified by \fIkey_id\fP.
+\fIlen\fP holds the size of the returned buffer.
+If \fIkeyring\fP is 0 the default keyring '.nvme' is used.
+.SH "RETURN"
+Pointer to the payload on success,
+or NULL with errno set otherwise.
-.TH "nvme_refresh_topology" 9 "nvme_refresh_topology" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_refresh_topology" 9 "nvme_refresh_topology" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_refresh_topology \- Refresh nvme_root_t object contents
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_register_offsets" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_register_offsets" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_register_offsets \- controller registers for all transports. This is the layout of BAR0/1 for PCIe, and properties for fabrics.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_registered_ctrl" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_registered_ctrl" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_registered_ctrl \- Registered Controller Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_registered_ctrl_ext" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_registered_ctrl_ext" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_registered_ctrl_ext \- Registered Controller Extended Data Structure
.SH SYNOPSIS
-.TH "nvme_rescan_ctrl" 9 "nvme_rescan_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_rescan_ctrl" 9 "nvme_rescan_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_rescan_ctrl \- Rescan an existing controller
.SH SYNOPSIS
-.TH "nvme_resv_acquire" 9 "nvme_resv_acquire" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_resv_acquire" 9 "nvme_resv_acquire" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_resv_acquire \- Send an nvme reservation acquire
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_resv_cptpl" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_cptpl" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_resv_cptpl \- Reservation Register - Change Persist Through Power Loss State
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_resv_notification_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_resv_notification_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_resv_notification_log \- Reservation Notification Log
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_resv_notify_rnlpt" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_notify_rnlpt" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_resv_notify_rnlpt \- Reservation Notification Log - Reservation Notification Log Page Type
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_resv_racqa" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_racqa" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_resv_racqa \- Reservation Acquire - Reservation Acquire Action
.SH SYNOPSIS
-.TH "nvme_resv_register" 9 "nvme_resv_register" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_resv_register" 9 "nvme_resv_register" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_resv_register \- Send an nvme reservation register
.SH SYNOPSIS
-.TH "nvme_resv_release" 9 "nvme_resv_release" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_resv_release" 9 "nvme_resv_release" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_resv_release \- Send an nvme reservation release
.SH SYNOPSIS
-.TH "nvme_resv_report" 9 "nvme_resv_report" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_resv_report" 9 "nvme_resv_report" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_resv_report \- Send an nvme reservation report
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_resv_rrega" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_rrega" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_resv_rrega \- Reservation Register - Reservation Register Action
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_resv_rrela" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_rrela" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_resv_rrela \- Reservation Release - Reservation Release Action
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_resv_rtype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_rtype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_resv_rtype \- Reservation Type Encoding
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_resv_status" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_resv_status" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_resv_status \- Reservation Status Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_sanitize_compln_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_sanitize_compln_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_sanitize_compln_event \- Sanitize Completion Event Data
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_sanitize_log_page" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_sanitize_log_page" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_sanitize_log_page \- Sanitize Status (Log Identifier 81h)
.SH SYNOPSIS
-.TH "nvme_sanitize_nvm" 9 "nvme_sanitize_nvm" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_sanitize_nvm" 9 "nvme_sanitize_nvm" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_sanitize_nvm \- Start a sanitize operation
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_sanitize_sanact" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_sanitize_sanact" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_sanitize_sanact \- Sanitize Action
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_sanitize_sstat" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_sanitize_sstat" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_sanitize_sstat \- Sanitize Status (SSTAT)
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_sanitize_start_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_sanitize_start_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_sanitize_start_event \- Sanitize Start Event Data
.SH SYNOPSIS
-.TH "nvme_scan" 9 "nvme_scan" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_scan" 9 "nvme_scan" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_scan \- Scan NVMe topology
.SH SYNOPSIS
-.TH "nvme_scan_ctrl" 9 "nvme_scan_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_scan_ctrl" 9 "nvme_scan_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_scan_ctrl \- Scan on a controller
.SH SYNOPSIS
-.TH "nvme_scan_ctrl_namespace_paths" 9 "nvme_scan_ctrl_namespace_paths" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_scan_ctrl_namespace_paths" 9 "nvme_scan_ctrl_namespace_paths" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_scan_ctrl_namespace_paths \- Scan for namespace paths in a controller
.SH SYNOPSIS
-.TH "nvme_scan_ctrl_namespaces" 9 "nvme_scan_ctrl_namespaces" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_scan_ctrl_namespaces" 9 "nvme_scan_ctrl_namespaces" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_scan_ctrl_namespaces \- Scan for namespaces in a controller
.SH SYNOPSIS
-.TH "nvme_scan_ctrls" 9 "nvme_scan_ctrls" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_scan_ctrls" 9 "nvme_scan_ctrls" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_scan_ctrls \- Scan for controllers
.SH SYNOPSIS
-.TH "nvme_scan_namespace" 9 "nvme_scan_namespace" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_scan_namespace" 9 "nvme_scan_namespace" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_scan_namespace \- scan namespace based on sysfs name
.SH SYNOPSIS
-.TH "nvme_scan_subsystem_namespaces" 9 "nvme_scan_subsystem_namespaces" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_scan_subsystem_namespaces" 9 "nvme_scan_subsystem_namespaces" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_scan_subsystem_namespaces \- Scan for namespaces in a subsystem
.SH SYNOPSIS
-.TH "nvme_scan_subsystems" 9 "nvme_scan_subsystems" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_scan_subsystems" 9 "nvme_scan_subsystems" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_scan_subsystems \- Scan for subsystems
.SH SYNOPSIS
--- /dev/null
+.TH "nvme_scan_tls_keys" 9 "nvme_scan_tls_keys" "May 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_scan_tls_keys \- Iterate over TLS keys in a keyring
+.SH SYNOPSIS
+.B "int" nvme_scan_tls_keys
+.BI "(const char *keyring " ","
+.BI "nvme_scan_tls_keys_cb_t cb " ","
+.BI "void *data " ");"
+.SH ARGUMENTS
+.IP "keyring" 12
+Keyring holding TLS keys
+.IP "cb" 12
+Callback function
+.IP "data" 12
+Pointer for data to be passed to \fIcb\fP
+.SH "DESCRIPTION"
+Iterates \fIkeyring\fP and call \fIcb\fP for each TLS key. When \fIkeyring\fP is NULL
+the default '.nvme' keyring is used.
+A TLS key must be of type 'psk' and the description must be of the
+form 'NVMe<0|1><R|G>0<1|2> <identity>', otherwise it will be skipped
+during iteration.
+.SH "RETURN"
+Number of keys for which \fIcb\fP was called, or -1 with errno set
+on error.
-.TH "nvme_scan_topology" 9 "nvme_scan_topology" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_scan_topology" 9 "nvme_scan_topology" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_scan_topology \- Scan NVMe topology and apply filter
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_secondary_ctrl" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_secondary_ctrl" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_secondary_ctrl \- Secondary Controller Entry
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_secondary_ctrl_list" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_secondary_ctrl_list" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_secondary_ctrl_list \- Secondary Controller List
.SH SYNOPSIS
-.TH "nvme_security_receive" 9 "nvme_security_receive" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_security_receive" 9 "nvme_security_receive" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_security_receive \- Security Receive command
.SH SYNOPSIS
-.TH "nvme_security_send" 9 "nvme_security_send" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_security_send" 9 "nvme_security_send" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_security_send \- Security Send command
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_self_test_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_self_test_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_self_test_log \- Device Self-test (Log Identifier 06h)
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_set_feat_event_layout" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_set_feat_event_layout \- This field indicates the set feature event layout
+.SH SYNOPSIS
+enum nvme_set_feat_event_layout {
+.br
+.BI " NVME_SET_FEAT_EVENT_DW_COUNT_SHIFT"
+,
+.br
+.br
+.BI " NVME_SET_FEAT_EVENT_CC_DW0_SHIFT"
+,
+.br
+.br
+.BI " NVME_SET_FEAT_EVENT_MB_COUNT_SHIFT"
+,
+.br
+.br
+.BI " NVME_SET_FEAT_EVENT_DW_COUNT_MASK"
+,
+.br
+.br
+.BI " NVME_SET_FEAT_EVENT_CC_DW0_MASK"
+,
+.br
+.br
+.BI " NVME_SET_FEAT_EVENT_MB_COUNT_MASK"
+
+};
+.SH Constants
+.IP "NVME_SET_FEAT_EVENT_DW_COUNT_SHIFT" 12
+Shift amount to get the Dword count from the
+\fIstruct nvme_set_feature_event\fP.layout field.
+.IP "NVME_SET_FEAT_EVENT_CC_DW0_SHIFT" 12
+Shift amount to get the logged command completion Dword 0
+from the \fIstruct nvme_set_feature_event\fP.layout field.
+.IP "NVME_SET_FEAT_EVENT_MB_COUNT_SHIFT" 12
+Shift amount to get the memory buffer count from
+the \fIstruct nvme_set_feature_event\fP.layout field.
+.IP "NVME_SET_FEAT_EVENT_DW_COUNT_MASK" 12
+Mask to get the Dword count from the \fIstruct
+nvme_set_feature_event\fP.layout field.
+.IP "NVME_SET_FEAT_EVENT_CC_DW0_MASK" 12
+Mask to get the logged command completion Dword 0 from
+the \fIstruct nvme_set_feature_event\fP.layout field.
+.IP "NVME_SET_FEAT_EVENT_MB_COUNT_MASK" 12
+Mask to get the memory buffer count from the \fIstruct
+nvme_set_feature_event\fP.layout field.
-.TH "libnvme" 9 "struct nvme_set_feature_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_set_feature_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_set_feature_event \- Set Feature Event Data
.SH SYNOPSIS
-.TH "nvme_set_features" 9 "nvme_set_features" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features" 9 "nvme_set_features" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features \- Set a feature attribute
.SH SYNOPSIS
-.TH "nvme_set_features_arbitration" 9 "nvme_set_features_arbitration" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_arbitration" 9 "nvme_set_features_arbitration" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_arbitration \- Set arbitration features
.SH SYNOPSIS
-.TH "nvme_set_features_async_event" 9 "nvme_set_features_async_event" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_async_event" 9 "nvme_set_features_async_event" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_async_event \- Set asynchronous event feature
.SH SYNOPSIS
-.TH "nvme_set_features_auto_pst" 9 "nvme_set_features_auto_pst" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_auto_pst" 9 "nvme_set_features_auto_pst" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_auto_pst \- Set autonomous power state feature
.SH SYNOPSIS
-.TH "nvme_set_features_data" 9 "nvme_set_features_data" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_data" 9 "nvme_set_features_data" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_data \- Helper function for @nvme_set_features()
.SH SYNOPSIS
-.TH "nvme_set_features_endurance_evt_cfg" 9 "nvme_set_features_endurance_evt_cfg" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_endurance_evt_cfg" 9 "nvme_set_features_endurance_evt_cfg" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_endurance_evt_cfg \- Set endurance event config feature
.SH SYNOPSIS
-.TH "nvme_set_features_err_recovery" 9 "nvme_set_features_err_recovery" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_err_recovery" 9 "nvme_set_features_err_recovery" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_err_recovery \- Set error recovery feature
.SH SYNOPSIS
-.TH "nvme_set_features_hctm" 9 "nvme_set_features_hctm" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_hctm" 9 "nvme_set_features_hctm" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_hctm \- Set thermal management feature
.SH SYNOPSIS
-.TH "nvme_set_features_host_behavior" 9 "nvme_set_features_host_behavior" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_host_behavior" 9 "nvme_set_features_host_behavior" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_host_behavior \- Set host behavior feature
.SH SYNOPSIS
-.TH "nvme_set_features_host_id" 9 "nvme_set_features_host_id" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_host_id" 9 "nvme_set_features_host_id" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_host_id \- Set enable extended host identifiers feature
.SH SYNOPSIS
-.TH "nvme_set_features_iocs_profile" 9 "nvme_set_features_iocs_profile" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_iocs_profile" 9 "nvme_set_features_iocs_profile" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_iocs_profile \- Set I/O command set profile feature
.SH SYNOPSIS
-.TH "nvme_set_features_irq_coalesce" 9 "nvme_set_features_irq_coalesce" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_irq_coalesce" 9 "nvme_set_features_irq_coalesce" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_irq_coalesce \- Set IRQ coalesce feature
.SH SYNOPSIS
-.TH "nvme_set_features_irq_config" 9 "nvme_set_features_irq_config" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_irq_config" 9 "nvme_set_features_irq_config" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_irq_config \- Set IRQ config feature
.SH SYNOPSIS
-.TH "nvme_set_features_lba_range" 9 "nvme_set_features_lba_range" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_lba_range" 9 "nvme_set_features_lba_range" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_lba_range \- Set LBA range feature
.SH SYNOPSIS
-.TH "nvme_set_features_lba_sts_interval" 9 "nvme_set_features_lba_sts_interval" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_lba_sts_interval" 9 "nvme_set_features_lba_sts_interval" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_lba_sts_interval \- Set LBA status information feature
.SH SYNOPSIS
-.TH "nvme_set_features_nopsc" 9 "nvme_set_features_nopsc" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_nopsc" 9 "nvme_set_features_nopsc" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_nopsc \- Set non-operational power state feature
.SH SYNOPSIS
-.TH "nvme_set_features_plm_config" 9 "nvme_set_features_plm_config" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_plm_config" 9 "nvme_set_features_plm_config" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_plm_config \- Set predictable latency feature
.SH SYNOPSIS
-.TH "nvme_set_features_plm_window" 9 "nvme_set_features_plm_window" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_plm_window" 9 "nvme_set_features_plm_window" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_plm_window \- Set window select feature
.SH SYNOPSIS
-.TH "nvme_set_features_power_mgmt" 9 "nvme_set_features_power_mgmt" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_power_mgmt" 9 "nvme_set_features_power_mgmt" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_power_mgmt \- Set power management feature
.SH SYNOPSIS
-.TH "nvme_set_features_resv_mask" 9 "nvme_set_features_resv_mask" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_resv_mask" 9 "nvme_set_features_resv_mask" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_resv_mask \- Set reservation notification mask feature
.SH SYNOPSIS
-.TH "nvme_set_features_resv_mask2" 9 "nvme_set_features_resv_mask2" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_resv_mask2" 9 "nvme_set_features_resv_mask2" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_resv_mask2 \- Set reservation notification mask feature
.SH SYNOPSIS
-.TH "nvme_set_features_resv_persist" 9 "nvme_set_features_resv_persist" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_resv_persist" 9 "nvme_set_features_resv_persist" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_resv_persist \- Set persist through power loss feature
.SH SYNOPSIS
-.TH "nvme_set_features_resv_persist2" 9 "nvme_set_features_resv_persist2" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_resv_persist2" 9 "nvme_set_features_resv_persist2" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_resv_persist2 \- Set persist through power loss feature
.SH SYNOPSIS
-.TH "nvme_set_features_rrl" 9 "nvme_set_features_rrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_rrl" 9 "nvme_set_features_rrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_rrl \- Set read recovery level feature
.SH SYNOPSIS
-.TH "nvme_set_features_sanitize" 9 "nvme_set_features_sanitize" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_sanitize" 9 "nvme_set_features_sanitize" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_sanitize \- Set sanitize feature
.SH SYNOPSIS
-.TH "nvme_set_features_simple" 9 "nvme_set_features_simple" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_simple" 9 "nvme_set_features_simple" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_simple \- Helper function for @nvme_set_features()
.SH SYNOPSIS
-.TH "nvme_set_features_sw_progress" 9 "nvme_set_features_sw_progress" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_sw_progress" 9 "nvme_set_features_sw_progress" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_sw_progress \- Set pre-boot software load count feature
.SH SYNOPSIS
-.TH "nvme_set_features_temp_thresh" 9 "nvme_set_features_temp_thresh" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_temp_thresh" 9 "nvme_set_features_temp_thresh" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_temp_thresh \- Set temperature threshold feature
.SH SYNOPSIS
-.TH "nvme_set_features_timestamp" 9 "nvme_set_features_timestamp" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_timestamp" 9 "nvme_set_features_timestamp" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_timestamp \- Set timestamp feature
.SH SYNOPSIS
-.TH "nvme_set_features_volatile_wc" 9 "nvme_set_features_volatile_wc" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_volatile_wc" 9 "nvme_set_features_volatile_wc" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_volatile_wc \- Set volatile write cache feature
.SH SYNOPSIS
-.TH "nvme_set_features_write_atomic" 9 "nvme_set_features_write_atomic" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_write_atomic" 9 "nvme_set_features_write_atomic" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_write_atomic \- Set write atomic feature
.SH SYNOPSIS
-.TH "nvme_set_features_write_protect" 9 "nvme_set_features_write_protect" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_write_protect" 9 "nvme_set_features_write_protect" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_write_protect \- Set write protect feature
.SH SYNOPSIS
-.TH "nvme_set_features_write_protect2" 9 "nvme_set_features_write_protect2" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_features_write_protect2" 9 "nvme_set_features_write_protect2" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_features_write_protect2 \- Set write protect feature
.SH SYNOPSIS
-.TH "nvme_set_keyring" 9 "nvme_set_keyring" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_keyring" 9 "nvme_set_keyring" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_keyring \- Link keyring for lookup
.SH SYNOPSIS
-.TH "nvme_set_property" 9 "nvme_set_property" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_property" 9 "nvme_set_property" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_property \- Set controller property
.SH SYNOPSIS
-.TH "nvme_set_root" 9 "nvme_set_root" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_set_root" 9 "nvme_set_root" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_set_root \- Set nvme_root_t context
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_smart_crit" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_smart_crit" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_smart_crit \- Critical Warning
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_smart_egcw" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_smart_egcw" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_smart_egcw \- Endurance Group Critical Warning Summary
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_smart_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_smart_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_smart_log \- SMART / Health Information Log (Log Identifier 02h)
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_st_code" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_st_code" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_st_code \- Self-test Code value
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_st_curr_op" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_st_curr_op" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_st_curr_op \- Current Device Self-Test Operation
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_st_result" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_st_result" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_st_result \- Self-test Result
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_st_valid_diag_info" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_st_valid_diag_info" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_st_valid_diag_info \- Valid Diagnostic Information
.SH SYNOPSIS
-.TH "nvme_status_code" 9 "nvme_status_code" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_status_code" 9 "nvme_status_code" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_status_code \- Returns the NVMe Status Code
.SH SYNOPSIS
-.TH "nvme_status_code_type" 9 "nvme_status_code_type" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_status_code_type" 9 "nvme_status_code_type" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_status_code_type \- Returns the NVMe Status Code Type
.SH SYNOPSIS
-.TH "nvme_status_equals" 9 "nvme_status_equals" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_status_equals" 9 "nvme_status_equals" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_status_equals \- helper to check a status against a type and value
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_status_field" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_status_field" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_status_field \- Defines all parts of the nvme status field: status code, status code type, and additional flags.
.SH SYNOPSIS
-.TH "nvme_status_get_type" 9 "nvme_status_get_type" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_status_get_type" 9 "nvme_status_get_type" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_status_get_type \- extract the type from a nvme_* return value
.SH SYNOPSIS
-.TH "nvme_status_get_value" 9 "nvme_status_get_value" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_status_get_value" 9 "nvme_status_get_value" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_status_get_value \- extract the status value from a nvme_* return value
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_status_result" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_status_result" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_status_result \- Result of the device self-test operation
.SH SYNOPSIS
-.TH "nvme_status_to_errno" 9 "nvme_status_to_errno" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_status_to_errno" 9 "nvme_status_to_errno" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_status_to_errno \- Converts nvme return status to errno
.SH SYNOPSIS
-.TH "nvme_status_to_string" 9 "nvme_status_to_string" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_status_to_string" 9 "nvme_status_to_string" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_status_to_string \- Returns string describing nvme return status.
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_status_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_status_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_status_type \- type encoding for NVMe return values, when represented as an int.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_streams_directive_params" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_streams_directive_params" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_streams_directive_params \- Streams Directive - Return Parameters Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_streams_directive_status" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_streams_directive_status" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_streams_directive_status \- Streams Directive - Get Status Data Structure
.SH SYNOPSIS
-.TH "nvme_submit_admin_passthru" 9 "nvme_submit_admin_passthru" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_submit_admin_passthru" 9 "nvme_submit_admin_passthru" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_submit_admin_passthru \- Submit an nvme passthrough admin command
.SH SYNOPSIS
-.TH "nvme_submit_admin_passthru64" 9 "nvme_submit_admin_passthru64" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_submit_admin_passthru64" 9 "nvme_submit_admin_passthru64" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_submit_admin_passthru64 \- Submit a 64-bit nvme passthrough admin command
.SH SYNOPSIS
-.TH "nvme_submit_io_passthru" 9 "nvme_submit_io_passthru" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_submit_io_passthru" 9 "nvme_submit_io_passthru" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_submit_io_passthru \- Submit an nvme passthrough command
.SH SYNOPSIS
-.TH "nvme_submit_io_passthru64" 9 "nvme_submit_io_passthru64" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_submit_io_passthru64" 9 "nvme_submit_io_passthru64" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_submit_io_passthru64 \- Submit a 64-bit nvme passthrough command
.SH SYNOPSIS
-.TH "nvme_subsys_filter" 9 "nvme_subsys_filter" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsys_filter" 9 "nvme_subsys_filter" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsys_filter \- Filter for subsystems
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_subsys_type" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_subsys_type" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_subsys_type \- Type of the NVM subsystem.
.SH SYNOPSIS
-.TH "nvme_subsystem_first_ctrl" 9 "nvme_subsystem_first_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_first_ctrl" 9 "nvme_subsystem_first_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_first_ctrl \- First ctrl iterator
.SH SYNOPSIS
-.TH "nvme_subsystem_first_ns" 9 "nvme_subsystem_first_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_first_ns" 9 "nvme_subsystem_first_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_first_ns \- Start namespace iterator
.SH SYNOPSIS
-.TH "nvme_subsystem_for_each_ctrl" 9 "nvme_subsystem_for_each_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_for_each_ctrl" 9 "nvme_subsystem_for_each_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_for_each_ctrl \- Traverse controllers
.SH SYNOPSIS
-.TH "nvme_subsystem_for_each_ctrl_safe" 9 "nvme_subsystem_for_each_ctrl_safe" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_for_each_ctrl_safe" 9 "nvme_subsystem_for_each_ctrl_safe" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_for_each_ctrl_safe \- Traverse controllers
.SH SYNOPSIS
-.TH "nvme_subsystem_for_each_ns" 9 "nvme_subsystem_for_each_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_for_each_ns" 9 "nvme_subsystem_for_each_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_for_each_ns \- Traverse namespaces
.SH SYNOPSIS
-.TH "nvme_subsystem_for_each_ns_safe" 9 "nvme_subsystem_for_each_ns_safe" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_for_each_ns_safe" 9 "nvme_subsystem_for_each_ns_safe" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_for_each_ns_safe \- Traverse namespaces
.SH SYNOPSIS
-.TH "nvme_subsystem_get_application" 9 "nvme_subsystem_get_application" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_application" 9 "nvme_subsystem_get_application" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_get_application \- Return the application string
.SH SYNOPSIS
-.TH "nvme_subsystem_get_host" 9 "nvme_subsystem_get_host" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_host" 9 "nvme_subsystem_get_host" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_get_host \- Returns nvme_host_t object
.SH SYNOPSIS
-.TH "nvme_subsystem_get_iopolicy" 9 "nvme_subsystem_get_iopolicy" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_iopolicy" 9 "nvme_subsystem_get_iopolicy" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_get_iopolicy \- Return the IO policy of subsytem
.SH SYNOPSIS
-.TH "nvme_subsystem_get_name" 9 "nvme_subsystem_get_name" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_name" 9 "nvme_subsystem_get_name" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_get_name \- sysfs name of an nvme_subsystem_t object
.SH SYNOPSIS
-.TH "nvme_subsystem_get_nqn" 9 "nvme_subsystem_get_nqn" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_nqn" 9 "nvme_subsystem_get_nqn" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_get_nqn \- Retrieve NQN from subsystem
.SH SYNOPSIS
-.TH "nvme_subsystem_get_sysfs_dir" 9 "nvme_subsystem_get_sysfs_dir" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_sysfs_dir" 9 "nvme_subsystem_get_sysfs_dir" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_get_sysfs_dir \- sysfs directory of an nvme_subsystem_t object
.SH SYNOPSIS
-.TH "nvme_subsystem_get_type" 9 "nvme_subsystem_get_type" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_type" 9 "nvme_subsystem_get_type" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_get_type \- Returns the type of a subsystem
.SH SYNOPSIS
-.TH "nvme_subsystem_lookup_namespace" 9 "nvme_subsystem_lookup_namespace" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_lookup_namespace" 9 "nvme_subsystem_lookup_namespace" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_lookup_namespace \- lookup namespace by NSID
.SH SYNOPSIS
-.TH "nvme_subsystem_next_ctrl" 9 "nvme_subsystem_next_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_next_ctrl" 9 "nvme_subsystem_next_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_next_ctrl \- Next ctrl iterator
.SH SYNOPSIS
-.TH "nvme_subsystem_next_ns" 9 "nvme_subsystem_next_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_next_ns" 9 "nvme_subsystem_next_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_next_ns \- Next namespace iterator
.SH SYNOPSIS
-.TH "nvme_subsystem_release_fds" 9 "nvme_subsystem_release_fds" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_release_fds" 9 "nvme_subsystem_release_fds" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_release_fds \- Close all opened fds under subsystem
.SH SYNOPSIS
-.TH "nvme_subsystem_reset" 9 "nvme_subsystem_reset" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_reset" 9 "nvme_subsystem_reset" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_reset \- Initiate a subsystem reset
.SH SYNOPSIS
-.TH "nvme_subsystem_set_application" 9 "nvme_subsystem_set_application" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_subsystem_set_application" 9 "nvme_subsystem_set_application" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_subsystem_set_application \- Set the application string
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_supported_cap_config_list_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_supported_cap_config_list_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_supported_cap_config_list_log \- Supported Capacity Configuration list log page
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_supported_log_pages" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_supported_log_pages" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_supported_log_pages \- Supported Log Pages - Log
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_telemetry_da" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_telemetry_da" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_telemetry_da \- Telemetry Log Data Area
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_telemetry_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_telemetry_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_telemetry_log \- Retrieve internal data specific to the manufacturer.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_thermal_exc_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_thermal_exc_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_thermal_exc_event \- Thermal Excursion Event Data
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_time_stamp_change_event" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_time_stamp_change_event" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_time_stamp_change_event \- Timestamp Change Event
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_timestamp" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_timestamp" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_timestamp \- Timestamp - Data Structure for Get Features
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_unit" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_unit \- Defined buffer size and write throughput granularity units
+.SH SYNOPSIS
+enum nvme_unit {
+.br
+.BI " NVME_UNIT_B"
+,
+.br
+.br
+.BI " NVME_UNIT_1K"
+,
+.br
+.br
+.BI " NVME_UNIT_1M"
+,
+.br
+.br
+.BI " NVME_UNIT_1G"
+
+};
+.SH Constants
+.IP "NVME_UNIT_B" 12
+Bytes or Bytes/second
+.IP "NVME_UNIT_1K" 12
+1 KiB or 1 KiB/second
+.IP "NVME_UNIT_1M" 12
+1 MiB or 1 MiB/second
+.IP "NVME_UNIT_1G" 12
+1 GiB or 1 GiB/second
-.TH "nvme_unlink_ctrl" 9 "nvme_unlink_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_unlink_ctrl" 9 "nvme_unlink_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_unlink_ctrl \- Unlink controller
.SH SYNOPSIS
-.TH "nvme_update_config" 9 "nvme_update_config" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_update_config" 9 "nvme_update_config" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_update_config \- Update JSON configuration
.SH SYNOPSIS
--- /dev/null
+.TH "nvme_update_key" 9 "nvme_update_key" "May 2024" "libnvme API manual" LINUX
+.SH NAME
+nvme_update_key \- Update key raw data
+.SH SYNOPSIS
+.B "long" nvme_update_key
+.BI "(long keyring_id " ","
+.BI "const char *key_type " ","
+.BI "const char *identity " ","
+.BI "unsigned char *key_data " ","
+.BI "int key_len " ");"
+.SH ARGUMENTS
+.IP "keyring_id" 12
+Id of the keyring holding key_id
+.IP "key_type" 12
+Type of the key to insert
+.IP "identity" 12
+Key identity string
+.IP "key_data" 12
+Raw data of the key
+.IP "key_len" 12
+Length of \fIkey_data\fP
+.SH "DESCRIPTION"
+Links the keyring specified by \fIkeyring_id\fP into the session
+keyring and updates the key reference by \fIidentity\fP with \fIkey_data\fP.
+The old key with identity \fIidentity\fP will be revoked to make it
+inaccessible.
+.SH "RETURN"
+Key id of the new key or 0 with errno set otherwise.
-.TH "libnvme" 9 "struct nvme_uring_cmd" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_uring_cmd" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_uring_cmd \- nvme uring command structure
.SH SYNOPSIS
-.TH "nvme_verify" 9 "nvme_verify" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_verify" 9 "nvme_verify" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_verify \- Send an nvme verify command
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_version" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_version" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_version \- Selector for version to be returned by @nvme_get_version
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_virt_mgmt_act" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_virt_mgmt_act" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_virt_mgmt_act \- Virtualization Management - Action
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_virt_mgmt_rt" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_virt_mgmt_rt" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_virt_mgmt_rt \- Virtualization Management - Resource Type
.SH SYNOPSIS
-.TH "nvme_virtual_mgmt" 9 "nvme_virtual_mgmt" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_virtual_mgmt" 9 "nvme_virtual_mgmt" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_virtual_mgmt \- Virtualization resource management
.SH SYNOPSIS
--- /dev/null
+.TH "libnvme" 9 "enum nvme_vs" "May 2024" "API Manual" LINUX
+.SH NAME
+enum nvme_vs \- This field indicates the version
+.SH SYNOPSIS
+enum nvme_vs {
+.br
+.BI " NVME_VS_TER_SHIFT"
+,
+.br
+.br
+.BI " NVME_VS_MNR_SHIFT"
+,
+.br
+.br
+.BI " NVME_VS_MJR_SHIFT"
+,
+.br
+.br
+.BI " NVME_VS_TER_MASK"
+,
+.br
+.br
+.BI " NVME_VS_MNR_MASK"
+,
+.br
+.br
+.BI " NVME_VS_MJR_MASK"
+
+};
+.SH Constants
+.IP "NVME_VS_TER_SHIFT" 12
+Shift amount to get the tertiary version
+.IP "NVME_VS_MNR_SHIFT" 12
+Shift amount to get the minor version
+.IP "NVME_VS_MJR_SHIFT" 12
+Shift amount to get the major version
+.IP "NVME_VS_TER_MASK" 12
+Mask to get the tertiary version
+.IP "NVME_VS_MNR_MASK" 12
+Mask to get the minor version
+.IP "NVME_VS_MJR_MASK" 12
+Mask to get the major version
-.TH "nvme_write" 9 "nvme_write" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_write" 9 "nvme_write" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_write \- Submit an nvme user write command
.SH SYNOPSIS
-.TH "nvme_write_uncorrectable" 9 "nvme_write_uncorrectable" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_write_uncorrectable" 9 "nvme_write_uncorrectable" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_write_uncorrectable \- Submit an nvme write uncorrectable command
.SH SYNOPSIS
-.TH "nvme_write_zeros" 9 "nvme_write_zeros" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_write_zeros" 9 "nvme_write_zeros" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_write_zeros \- Submit an nvme write zeroes command
.SH SYNOPSIS
-.TH "nvme_zns_append" 9 "nvme_zns_append" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_zns_append" 9 "nvme_zns_append" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_zns_append \- Append data to a zone
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_zns_changed_zone_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zns_changed_zone_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_zns_changed_zone_log \- ZNS Changed Zone List log
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_zns_desc" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zns_desc" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_zns_desc \- Zone Descriptor Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_zns_id_ctrl" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zns_id_ctrl" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_zns_id_ctrl \- I/O Command Set Specific Identify Controller Data Structure for the Zoned Namespace Command Set
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_zns_id_ns" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zns_id_ns" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_zns_id_ns \- Zoned Namespace Command Set Specific Identify Namespace Data Structure
.SH SYNOPSIS
-.TH "nvme_zns_identify_ctrl" 9 "nvme_zns_identify_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_zns_identify_ctrl" 9 "nvme_zns_identify_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_zns_identify_ctrl \- ZNS identify controller data
.SH SYNOPSIS
-.TH "nvme_zns_identify_ns" 9 "nvme_zns_identify_ns" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_zns_identify_ns" 9 "nvme_zns_identify_ns" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_zns_identify_ns \- ZNS identify namespace data
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_zns_lbafe" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zns_lbafe" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_zns_lbafe \- LBA Format Extension Data Structure
.SH SYNOPSIS
-.TH "nvme_zns_mgmt_recv" 9 "nvme_zns_mgmt_recv" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_zns_mgmt_recv" 9 "nvme_zns_mgmt_recv" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_zns_mgmt_recv \- ZNS management receive command
.SH SYNOPSIS
-.TH "nvme_zns_mgmt_send" 9 "nvme_zns_mgmt_send" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_zns_mgmt_send" 9 "nvme_zns_mgmt_send" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_zns_mgmt_send \- ZNS management send command
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_zns_recv_action" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_recv_action" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_zns_recv_action \- Zone Management Receive - Zone Receive Action Specific Features
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_zns_report_options" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_report_options" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_zns_report_options \- Zone Management Receive - Zone Receive Action Specific Field
.SH SYNOPSIS
-.TH "nvme_zns_report_zones" 9 "nvme_zns_report_zones" "February 2024" "libnvme API manual" LINUX
+.TH "nvme_zns_report_zones" 9 "nvme_zns_report_zones" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvme_zns_report_zones \- Return the list of zones
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_zns_send_action" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_send_action" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_zns_send_action \- Zone Management Send - Zone Send Action
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_zns_za" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_za" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_zns_za \- Zone Descriptor Data Structure
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_zns_zs" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_zs" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_zns_zs \- Zone Descriptor Data Structure - Zone State
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvme_zns_zt" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_zt" "May 2024" "API Manual" LINUX
.SH NAME
enum nvme_zns_zt \- Zone Descriptor Data Structure - Zone Type
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvme_zone_report" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zone_report" "May 2024" "API Manual" LINUX
.SH NAME
struct nvme_zone_report \- Report Zones Data Structure
.SH SYNOPSIS
-.TH "nvmf_add_ctrl" 9 "nvmf_add_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_add_ctrl" 9 "nvmf_add_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_add_ctrl \- Connect a controller and update topology
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_addr_family" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_addr_family" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_addr_family \- Address Family codes for Discovery Log Page entry ADRFAM field
.SH SYNOPSIS
-.TH "nvmf_adrfam_str" 9 "nvmf_adrfam_str" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_adrfam_str" 9 "nvmf_adrfam_str" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_adrfam_str \- Decode ADRFAM field
.SH SYNOPSIS
-.TH "nvmf_cms_str" 9 "nvmf_cms_str" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_cms_str" 9 "nvmf_cms_str" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_cms_str \- Decode RDMA connection management service field
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvmf_connect_data" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_connect_data" "May 2024" "API Manual" LINUX
.SH NAME
struct nvmf_connect_data \- Data payload for the 'connect' command
.SH SYNOPSIS
-.TH "nvmf_connect_disc_entry" 9 "nvmf_connect_disc_entry" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_connect_disc_entry" 9 "nvmf_connect_disc_entry" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_connect_disc_entry \- Connect controller based on the discovery log page entry
.SH SYNOPSIS
-.TH "nvmf_default_config" 9 "nvmf_default_config" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_default_config" 9 "nvmf_default_config" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_default_config \- Default values for fabrics configuration
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvmf_dim_data" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_dim_data" "May 2024" "API Manual" LINUX
.SH NAME
struct nvmf_dim_data \- Discovery Information Management (DIM) - Data
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_dim_entfmt" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_dim_entfmt" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_dim_entfmt \- Discovery Information Management Entry Format
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_dim_etype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_dim_etype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_dim_etype \- Discovery Information Management Entity Type
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_dim_tas" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_dim_tas" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_dim_tas \- Discovery Information Management Task
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_disc_eflags" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_disc_eflags" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_disc_eflags \- Discovery Log Page entry flags.
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvmf_disc_log_entry" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_disc_log_entry" "May 2024" "API Manual" LINUX
.SH NAME
struct nvmf_disc_log_entry \- Discovery Log Page entry
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvmf_discovery_log" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_discovery_log" "May 2024" "API Manual" LINUX
.SH NAME
struct nvmf_discovery_log \- Discovery Log Page (Log Identifier 70h)
.SH SYNOPSIS
-.TH "nvmf_eflags_str" 9 "nvmf_eflags_str" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_eflags_str" 9 "nvmf_eflags_str" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_eflags_str \- Decode EFLAGS field
.SH SYNOPSIS
-.TH "nvmf_exat_len" 9 "nvmf_exat_len" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_exat_len" 9 "nvmf_exat_len" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_exat_len \- Return length rounded up by 4
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_exattype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_exattype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_exattype \- Extended Attribute Type
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvmf_ext_attr" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_ext_attr" "May 2024" "API Manual" LINUX
.SH NAME
struct nvmf_ext_attr \- Extended Attribute (EXAT)
.SH SYNOPSIS
-.TH "libnvme" 9 "struct nvmf_ext_die" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_ext_die" "May 2024" "API Manual" LINUX
.SH NAME
struct nvmf_ext_die \- Extended Discovery Information Entry (DIE)
.SH SYNOPSIS
-.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_get_discovery_log \- Return the discovery log page
.SH SYNOPSIS
-.TH "nvmf_get_discovery_wargs" 9 "nvmf_get_discovery_wargs" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_get_discovery_wargs" 9 "nvmf_get_discovery_wargs" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_get_discovery_wargs \- Get the discovery log page with args
.SH SYNOPSIS
-.TH "nvmf_hostid_from_file" 9 "nvmf_hostid_from_file" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_hostid_from_file" 9 "nvmf_hostid_from_file" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_hostid_from_file \- Reads the host identifier from the config default location
.SH SYNOPSIS
-.TH "nvmf_hostnqn_from_file" 9 "nvmf_hostnqn_from_file" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_hostnqn_from_file" 9 "nvmf_hostnqn_from_file" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_hostnqn_from_file \- Reads the host nvm qualified name from the config default location
.SH SYNOPSIS
-.TH "nvmf_hostnqn_generate" 9 "nvmf_hostnqn_generate" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_hostnqn_generate" 9 "nvmf_hostnqn_generate" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_hostnqn_generate \- Generate a machine specific host nqn
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_log_discovery_lid_support" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_log_discovery_lid_support" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_log_discovery_lid_support \- Discovery log specific support
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_log_discovery_lsp" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_log_discovery_lsp" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_log_discovery_lsp \- Discovery log specific field
.SH SYNOPSIS
-.TH "nvmf_prtype_str" 9 "nvmf_prtype_str" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_prtype_str" 9 "nvmf_prtype_str" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_prtype_str \- Decode RDMA Provider type field
.SH SYNOPSIS
-.TH "nvmf_qptype_str" 9 "nvmf_qptype_str" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_qptype_str" 9 "nvmf_qptype_str" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_qptype_str \- Decode RDMA QP Service type field
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_rdma_cms" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_rdma_cms" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_rdma_cms \- RDMA Connection Management Service Type codes for Discovery Log Page entry TSAS RDMA_CMS field
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_rdma_prtype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_rdma_prtype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_rdma_prtype \- RDMA Provider Type codes for Discovery Log Page entry TSAS RDMA_PRTYPE field
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_rdma_qptype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_rdma_qptype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_rdma_qptype \- RDMA QP Service Type codes for Discovery Log Page entry TSAS RDMA_QPTYPE field
.SH SYNOPSIS
-.TH "nvmf_register_ctrl" 9 "nvmf_register_ctrl" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_register_ctrl" 9 "nvmf_register_ctrl" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_register_ctrl \- Perform registration task with a DC
.SH SYNOPSIS
-.TH "nvmf_sectype_str" 9 "nvmf_sectype_str" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_sectype_str" 9 "nvmf_sectype_str" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_sectype_str \- Decode SECTYPE field
.SH SYNOPSIS
-.TH "nvmf_subtype_str" 9 "nvmf_subtype_str" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_subtype_str" 9 "nvmf_subtype_str" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_subtype_str \- Decode SUBTYPE field
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_tcp_sectype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_tcp_sectype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_tcp_sectype \- Transport Specific Address Subtype Definition for NVMe/TCP Transport
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_treq" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_treq" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_treq \- Transport Requirements codes for Discovery Log Page entry TREQ field
.SH SYNOPSIS
-.TH "nvmf_treq_str" 9 "nvmf_treq_str" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_treq_str" 9 "nvmf_treq_str" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_treq_str \- Decode TREQ field
.SH SYNOPSIS
-.TH "libnvme" 9 "enum nvmf_trtype" "February 2024" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_trtype" "May 2024" "API Manual" LINUX
.SH NAME
enum nvmf_trtype \- Transport Type codes for Discovery Log Page entry TRTYPE field
.SH SYNOPSIS
-.TH "nvmf_trtype_str" 9 "nvmf_trtype_str" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_trtype_str" 9 "nvmf_trtype_str" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_trtype_str \- Decode TRTYPE field
.SH SYNOPSIS
-.TH "nvmf_update_config" 9 "nvmf_update_config" "February 2024" "libnvme API manual" LINUX
+.TH "nvmf_update_config" 9 "nvmf_update_config" "May 2024" "libnvme API manual" LINUX
.SH NAME
nvmf_update_config \- Update fabrics configuration values
.SH SYNOPSIS
int nr_write_queues;
int nr_poll_queues;
int tos;
- int keyring;
- int tls_key;
+ long keyring;
+ long tls_key;
bool duplicate_connect;
bool disable_sqflow;
bool hdr_digest;
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+.. c:function:: int nvme_ns_mgmt_delete_timeout (int fd, __u32 nsid, __u32 timeout)
+
+ Delete a non attached namespace with timeout
+
+**Parameters**
+
+``int fd``
+ File descriptor of nvme device
+
+``__u32 nsid``
+ Namespace identifier to delete
+
+``__u32 timeout``
+ Override the default timeout to this value in milliseconds;
+ set to 0 to use the system default.
+
+**Description**
+
+It is recommended that a namespace being deleted is not attached to any
+controller. Use the nvme_ns_detach_ctrls() first if the namespace is still
+attached.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
.. c:function:: int nvme_ns_mgmt_delete (int fd, __u32 nsid)
Delete a non attached namespace
:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
-.. c:function:: void nvme_set_debug (bool debug)
-
- Set NVMe command debugging output
-
-**Parameters**
-
-``bool debug``
- true to enable or false to disable
-
-
-.. c:function:: bool nvme_get_debug (void)
-
- Get NVMe command debugging output
-
-**Parameters**
-
-``void``
- no arguments
-
-**Return**
-
-false if disabled or true if enabled.
-
-
with errno set.
+.. c:function:: unsigned char * nvme_read_key (long keyring_id, long key_id, int *len)
+
+ Read key raw data
+
+**Parameters**
+
+``long keyring_id``
+ Id of the keyring holding ``key_id``
+
+``long key_id``
+ Key id
+
+``int *len``
+ Length of the returned data
+
+**Description**
+
+Links the keyring specified by **keyring_id** into the session
+keyring and reads the payload of the key specified by **key_id**.
+**len** holds the size of the returned buffer.
+If **keyring** is 0 the default keyring '.nvme' is used.
+
+**Return**
+
+Pointer to the payload on success,
+or NULL with errno set otherwise.
+
+
+.. c:function:: long nvme_update_key (long keyring_id, const char *key_type, const char *identity, unsigned char *key_data, int key_len)
+
+ Update key raw data
+
+**Parameters**
+
+``long keyring_id``
+ Id of the keyring holding ``key_id``
+
+``const char *key_type``
+ Type of the key to insert
+
+``const char *identity``
+ Key identity string
+
+``unsigned char *key_data``
+ Raw data of the key
+
+``int key_len``
+ Length of **key_data**
+
+**Description**
+
+Links the keyring specified by **keyring_id** into the session
+keyring and updates the key reference by **identity** with **key_data**.
+The old key with identity **identity** will be revoked to make it
+inaccessible.
+
+**Return**
+
+Key id of the new key or 0 with errno set otherwise.
+
+
+.. c:macro:: nvme_scan_tls_keys_cb_t
+
+ **Typedef**: Callback for iterating TLS keys
+
+
+**Syntax**
+
+ ``void nvme_scan_tls_keys_cb_t (long keyring, long key, char *desc, int desc_len, void *data)``
+
+**Parameters**
+
+``long keyring``
+ Keyring which has been iterated
+
+``long key``
+ Key for which the callback has been invoked
+
+``char *desc``
+ Description of the key
+
+``int desc_len``
+ Length of **desc**
+
+``void *data``
+ Pointer for caller data
+
+**Description**
+
+Called for each TLS PSK in the keyring.
+
+
+.. c:function:: int nvme_scan_tls_keys (const char *keyring, nvme_scan_tls_keys_cb_t cb, void *data)
+
+ Iterate over TLS keys in a keyring
+
+**Parameters**
+
+``const char *keyring``
+ Keyring holding TLS keys
+
+``nvme_scan_tls_keys_cb_t cb``
+ Callback function
+
+``void *data``
+ Pointer for data to be passed to **cb**
+
+**Description**
+
+Iterates **keyring** and call **cb** for each TLS key. When **keyring** is NULL
+the default '.nvme' keyring is used.
+A TLS key must be of type 'psk' and the description must be of the
+form 'NVMe<0|1><R|G>0<1|2> <identity>', otherwise it will be skipped
+during iteration.
+
+**Return**
+
+Number of keys for which **cb** was called, or -1 with errno set
+on error.
+
+
.. c:function:: long nvme_insert_tls_key (const char *keyring, const char *key_type, const char *hostnqn, const char *subsysnqn, int hmac, unsigned char *configured_key, int key_len)
Derive and insert TLS key
of the caller to free the returned string.
+.. c:function:: char * nvme_export_tls_key (const unsigned char *key_data, int key_len)
+
+ Export a TLS key
+
+**Parameters**
+
+``const unsigned char *key_data``
+ Raw data of the key
+
+``int key_len``
+ Length of **key_data**
+
+**Description**
+
+Returns **key_data** in the PSK Interchange format as defined in section
+3.6.1.5 of the NVMe TCP Transport specification.
+
+**Return**
+
+The string containing the TLS identity or NULL with errno set
+on error. It is the responsibility of the caller to free the returned
+string.
+
+
+.. c:function:: unsigned char * nvme_import_tls_key (const char *encoded_key, int *key_len, unsigned int *hmac)
+
+ Import a TLS key
+
+**Parameters**
+
+``const char *encoded_key``
+ TLS key in PSK interchange format
+
+``int *key_len``
+ Length of the resulting key data
+
+``unsigned int *hmac``
+ HMAC algorithm
+
+**Description**
+
+Imports **key_data** in the PSK Interchange format as defined in section
+3.6.1.5 of the NVMe TCP Transport specification.
+
+**Return**
+
+The raw data of the PSK or NULL with errno set on error. It is
+the responsibility of the caller to free the returned string.
+
+
+.. c:function:: int nvme_submit_passthru (int fd, unsigned long ioctl_cmd, struct nvme_passthru_cmd *cmd, __u32 *result)
+
+ Low level ioctl wrapper for passthru commands
+
+**Parameters**
+
+``int fd``
+ File descriptor of the nvme device
+
+``unsigned long ioctl_cmd``
+ IOCTL command id
+
+``struct nvme_passthru_cmd *cmd``
+ Passhtru command
+
+``__u32 *result``
+ Optional field to return the result
+
+**Description**
+
+This is a low level library function which should not be used directly. It is
+exposed as weak symbol so that the user application is able to provide their own
+implementation of this function with additional debugging or logging code.
+
+**Return**
+
+The value from the ioctl system call (see ioctl documentation)
+
+
+.. c:function:: int nvme_submit_passthru64 (int fd, unsigned long ioctl_cmd, struct nvme_passthru_cmd64 *cmd, __u64 *result)
+
+ Low level ioctl wrapper for passthru commands
+
+**Parameters**
+
+``int fd``
+ File descriptor of the nvme device
+
+``unsigned long ioctl_cmd``
+ IOCTL command id
+
+``struct nvme_passthru_cmd64 *cmd``
+ Passhtru command
+
+``__u64 *result``
+ Optional field to return the result
+
+**Description**
+
+This is a low level library function which should not be used directly. It is
+exposed as weak symbol so that the user application is able to provide their own
+implementation of this function with additional debugging or logging code.
+
+**Return**
+
+The value from the ioctl system call (see ioctl documentation)
+
+
Sets the default logging variables for the library.
+.. c:function:: int nvme_get_logging_level (nvme_root_t r, bool *log_pid, bool *log_tstamp)
+
+ Get current logging level
+
+**Parameters**
+
+``nvme_root_t r``
+ nvme_root_t context
+
+``bool *log_pid``
+ Pointer to store a current value of logging of
+ the PID flag at (optional).
+
+``bool *log_tstamp``
+ Pointer to store a current value of logging of
+ the timestamp flag at (optional).
+
+**Description**
+
+Retrieves current values of logging variables.
+
+**Return**
+
+current log level value or DEFAULT_LOGLEVEL if not initialized.
+
+
.. c:function:: void nvme_set_root (nvme_root_t r)
Set nvme_root_t context
the global root object.
+.. c:function:: void nvme_set_debug (bool debug)
+
+ Set NVMe command debugging output
+
+**Parameters**
+
+``bool debug``
+ true to enable or false to disable
+
+**Description**
+
+Don't use it, it's debricated.
+
+
+.. c:function:: bool nvme_get_debug (void)
+
+ Get NVMe command debugging output
+
+**Parameters**
+
+``void``
+ no arguments
+
+**Description**
+
+
+Don't use it, it's debricated.
+
+**Return**
+
+false if disabled or true if enabled.
+
+
+.. _nbft.h:
+
+**nbft.h**
+
+
+NVM Express Boot Specification, Revision 1.0
+
+Note: this API is currently unstable, subject to further additions.
+
.. c:enum:: nbft_desc_type
int controller_id;
int asqsz;
char *dhcp_root_path_string;
+ bool discovered;
+ bool unavailable;
};
**Members**
DHCP Root Path Override string (SSNS Extended
Information Descriptor).
+``discovered``
+ Indicates that this namespace was acquired
+ through discovery.
+
+``unavailable``
+ Namespace is unavailable as indicated by
+ the pre-OS driver.
+
DH-HMAC-CHAP host key or NULL if not set
+.. c:function:: const char * nvme_ctrl_get_cntlid (nvme_ctrl_t c)
+
+ Controller id
+
+**Parameters**
+
+``nvme_ctrl_t c``
+ Controller to be checked
+
+**Return**
+
+Controller id of **c**
+
+
.. c:function:: void nvme_ctrl_set_dhchap_host_key (nvme_ctrl_t c, const char *key)
Set host key
true if given offset is 64bit register, otherwise it returns false.
+
+
+.. c:enum:: nvme_cap
+
+ This field indicates the controller capabilities register
+
+**Constants**
+
+``NVME_CAP_MQES_SHIFT``
+ Shift amount to get the maximum queue entries supported
+
+``NVME_CAP_CQR_SHIFT``
+ Shift amount to get the contiguous queues required
+
+``NVME_CAP_AMS_SHIFT``
+ Shift amount to get the arbitration mechanism supported
+
+``NVME_CAP_TO_SHIFT``
+ Shift amount to get the timeout
+
+``NVME_CAP_DSTRD_SHIFT``
+ Shift amount to get the doorbell stride
+
+``NVME_CAP_NSSRC_SHIFT``
+ Shift amount to get the NVM subsystem reset supported
+
+``NVME_CAP_CSS_SHIFT``
+ Shift amount to get the command sets supported
+
+``NVME_CAP_BPS_SHIFT``
+ Shift amount to get the boot partition support
+
+``NVME_CAP_CPS_SHIFT``
+ Shift amount to get the controller power scope
+
+``NVME_CAP_MPSMIN_SHIFT``
+ Shift amount to get the memory page size minimum
+
+``NVME_CAP_MPSMAX_SHIFT``
+ Shift amount to get the memory page size maximum
+
+``NVME_CAP_PMRS_SHIFT``
+ Shift amount to get the persistent memory region supported
+
+``NVME_CAP_CMBS_SHIFT``
+ Shift amount to get the controller memory buffer supported
+
+``NVME_CAP_NSSS_SHIFT``
+ Shift amount to get the NVM subsystem shutdown supported
+
+``NVME_CAP_CRMS_SHIFT``
+ Shift amount to get the controller ready modes supported
+
+``NVME_CAP_MQES_MASK``
+ Mask to get the maximum queue entries supported
+
+``NVME_CAP_CQR_MASK``
+ Mask to get the contiguous queues required
+
+``NVME_CAP_AMS_MASK``
+ Mask to get the arbitration mechanism supported
+
+``NVME_CAP_TO_MASK``
+ Mask to get the timeout
+
+``NVME_CAP_DSTRD_MASK``
+ Mask to get the doorbell stride
+
+``NVME_CAP_NSSRC_MASK``
+ Mask to get the NVM subsystem reset supported
+
+``NVME_CAP_CSS_MASK``
+ Mask to get the command sets supported
+
+``NVME_CAP_BPS_MASK``
+ Mask to get the boot partition support
+
+``NVME_CAP_CPS_MASK``
+ Mask to get the controller power scope
+
+``NVME_CAP_MPSMIN_MASK``
+ Mask to get the memory page size minimum
+
+``NVME_CAP_MPSMAX_MASK``
+ Mask to get the memory page size maximum
+
+``NVME_CAP_PMRS_MASK``
+ Mask to get the persistent memory region supported
+
+``NVME_CAP_CMBS_MASK``
+ Mask to get the controller memory buffer supported
+
+``NVME_CAP_NSSS_MASK``
+ Mask to get the NVM subsystem shutdown supported
+
+``NVME_CAP_CRMS_MASK``
+ Mask to get the controller ready modes supported
+
+``NVME_CAP_AMS_WRR``
+ Weighted round robin with urgent priority class
+
+``NVME_CAP_AMS_VS``
+ Vendor specific
+
+``NVME_CAP_CSS_NVM``
+ NVM command set or a discovery controller
+
+``NVME_CAP_CSS_CSI``
+ Controller supports one or more I/O command sets
+
+``NVME_CAP_CSS_ADMIN``
+ No I/O command set is supported
+
+``NVME_CAP_CPS_NONE``
+ Not reported
+
+``NVME_CAP_CPS_CTRL``
+ Controller scope
+
+``NVME_CAP_CPS_DOMAIN``
+ Domain scope
+
+``NVME_CAP_CPS_NVMS``
+ NVM subsystem scope
+
+``NVME_CAP_CRWMS``
+ Controller ready with media support
+
+``NVME_CAP_CRIMS``
+ Controller ready independent of media support
+
+
+
+
+.. c:enum:: nvme_vs
+
+ This field indicates the version
+
+**Constants**
+
+``NVME_VS_TER_SHIFT``
+ Shift amount to get the tertiary version
+
+``NVME_VS_MNR_SHIFT``
+ Shift amount to get the minor version
+
+``NVME_VS_MJR_SHIFT``
+ Shift amount to get the major version
+
+``NVME_VS_TER_MASK``
+ Mask to get the tertiary version
+
+``NVME_VS_MNR_MASK``
+ Mask to get the minor version
+
+``NVME_VS_MJR_MASK``
+ Mask to get the major version
+
+
+
+
+.. c:enum:: nvme_cc
+
+ This field indicates the controller configuration
+
+**Constants**
+
+``NVME_CC_EN_SHIFT``
+ Shift amount to get the enable
+
+``NVME_CC_CSS_SHIFT``
+ Shift amount to get the I/O command set selected
+
+``NVME_CC_MPS_SHIFT``
+ Shift amount to get the memory page size
+
+``NVME_CC_AMS_SHIFT``
+ Shift amount to get the arbitration mechanism selected
+
+``NVME_CC_SHN_SHIFT``
+ Shift amount to get the shutdown notification
+
+``NVME_CC_IOSQES_SHIFT``
+ Shift amount to get the I/O submission queue entry size
+
+``NVME_CC_IOCQES_SHIFT``
+ Shift amount to get the I/O completion queue entry size
+
+``NVME_CC_CRIME_SHIFT``
+ Shift amount to get the controller ready independent of media enable
+
+``NVME_CC_EN_MASK``
+ Mask to get the enable
+
+``NVME_CC_CSS_MASK``
+ Mask to get the I/O command set selected
+
+``NVME_CC_MPS_MASK``
+ Mask to get the memory page size
+
+``NVME_CC_AMS_MASK``
+ Mask to get the arbitration mechanism selected
+
+``NVME_CC_SHN_MASK``
+ Mask to get the shutdown notification
+
+``NVME_CC_CRIME_MASK``
+ Mask to get the I/O submission queue entry size
+
+``NVME_CC_IOSQES_MASK``
+ Mask to get the I/O completion queue entry size
+
+``NVME_CC_IOCQES_MASK``
+ Mask to get the controller ready independent of media enable
+
+``NVME_CC_CSS_NVM``
+ NVM command set
+
+``NVME_CC_CSS_CSI``
+ All supported I/O command sets
+
+``NVME_CC_CSS_ADMIN``
+ Admin command set only
+
+``NVME_CC_AMS_RR``
+ Round robin
+
+``NVME_CC_AMS_WRRU``
+ Weighted round robin with urgent priority class
+
+``NVME_CC_AMS_VS``
+ Vendor specific
+
+``NVME_CC_SHN_NONE``
+ No notification; no effect
+
+``NVME_CC_SHN_NORMAL``
+ Normal shutdown notification
+
+``NVME_CC_SHN_ABRUPT``
+ Abrupt shutdown notification
+
+``NVME_CC_CRWME``
+ Controller ready with media enable
+
+``NVME_CC_CRIME``
+ Controller ready independent of media enable
+
+
+
+
+.. c:enum:: nvme_csts
+
+ This field indicates the controller status register
+
+**Constants**
+
+``NVME_CSTS_RDY_SHIFT``
+ Shift amount to get the ready
+
+``NVME_CSTS_CFS_SHIFT``
+ Shift amount to get the controller fatal status
+
+``NVME_CSTS_SHST_SHIFT``
+ Shift amount to get the shutdown status
+
+``NVME_CSTS_NSSRO_SHIFT``
+ Shift amount to get the NVM subsystem reset occurred
+
+``NVME_CSTS_PP_SHIFT``
+ Shift amount to get the processing paused
+
+``NVME_CSTS_ST_SHIFT``
+ Shift amount to get the shutdown type
+
+``NVME_CSTS_RDY_MASK``
+ Mask to get the ready
+
+``NVME_CSTS_CFS_MASK``
+ Mask to get the controller fatal status
+
+``NVME_CSTS_SHST_MASK``
+ Mask to get the shutdown status
+
+``NVME_CSTS_NSSRO_MASK``
+ Mask to get the NVM subsystem reset occurred
+
+``NVME_CSTS_PP_MASK``
+ Mask to get the processing paused
+
+``NVME_CSTS_ST_MASK``
+ Mask to get the shutdown type
+
+``NVME_CSTS_SHST_NORMAL``
+ Normal operation
+
+``NVME_CSTS_SHST_OCCUR``
+ Shutdown processing occurring
+
+``NVME_CSTS_SHST_CMPLT``
+ Shutdown processing complete
+
+``NVME_CSTS_SHN_MASK``
+ Deprecated mask to get the shutdown status
+
+
+
+
+.. c:enum:: nvme_aqa
+
+ This field indicates the admin queue attributes
+
+**Constants**
+
+``NVME_AQA_ASQS_SHIFT``
+ Shift amount to get the admin submission queue size
+
+``NVME_AQA_ACQS_SHIFT``
+ Shift amount to get the admin completion queue size
+
+``NVME_AQA_ASQS_MASK``
+ Mask to get the admin submission queue size
+
+``NVME_AQA_ACQS_MASK``
+ Mask to get the admin completion queue size
+
+
+
+
+.. c:enum:: nvme_asq
+
+ This field indicates the admin submission queue base address
+
+**Constants**
+
+``NVME_ASQ_ASQB_SHIFT``
+ Shift amount to get the admin submission queue base
+
+
+
+
+.. c:enum:: nvme_acq
+
+ This field indicates the admin completion queue base address
+
+**Constants**
+
+``NVME_ACQ_ACQB_SHIFT``
+ Shift amount to get the admin completion queue base
+
+
+
+
+.. c:enum:: nvme_cmbloc
+
+ This field indicates the controller memory buffer location
+
+**Constants**
+
+``NVME_CMBLOC_BIR_SHIFT``
+ Shift amount to get the base indicator register
+
+``NVME_CMBLOC_CQMMS_SHIFT``
+ Shift amount to get the CMB queue mixed memory support
+
+``NVME_CMBLOC_CQPDS_SHIFT``
+ Shift amount to get the CMB queue physically discontiguous support
+
+``NVME_CMBLOC_CDPLMS_SHIFT``
+ Shift amount to get the CMB data pointer mixed locations support
+
+``NVME_CMBLOC_CDPCILS_SHIFT``
+ Shift amount to get the CMB data pointer and command independent locations support
+
+``NVME_CMBLOC_CDMMMS_SHIFT``
+ Shift amount to get the CMB data metadata mixed memory support
+
+``NVME_CMBLOC_CQDA_SHIFT``
+ Shift amount to get the CMB queue dword alignment
+
+``NVME_CMBLOC_OFST_SHIFT``
+ Shift amount to get the offset
+
+``NVME_CMBLOC_BIR_MASK``
+ Mask to get the base indicator register
+
+``NVME_CMBLOC_CQMMS_MASK``
+ Mask to get the CMB queue mixed memory support
+
+``NVME_CMBLOC_CQPDS_MASK``
+ Mask to get the CMB queue physically discontiguous support
+
+``NVME_CMBLOC_CDPLMS_MASK``
+ Mask to get the CMB data pointer mixed locations support
+
+``NVME_CMBLOC_CDPCILS_MASK``
+ Mask to get the CMB data pointer and command independent locations support
+
+``NVME_CMBLOC_CDMMMS_MASK``
+ Mask to get the CMB data metadata mixed memory support
+
+``NVME_CMBLOC_CQDA_MASK``
+ Mask to get the CMB queue dword alignment
+
+``NVME_CMBLOC_OFST_MASK``
+ Mask to get the offset
+
+
+
+
+.. c:enum:: nvme_cmbsz
+
+ This field indicates the controller memory buffer size
+
+**Constants**
+
+``NVME_CMBSZ_SQS_SHIFT``
+ Shift amount to get the submission queue support
+
+``NVME_CMBSZ_CQS_SHIFT``
+ Shift amount to get the completion queue support
+
+``NVME_CMBSZ_LISTS_SHIFT``
+ Shift amount to get the PLP SGL list support
+
+``NVME_CMBSZ_RDS_SHIFT``
+ Shift amount to get the read data support
+
+``NVME_CMBSZ_WDS_SHIFT``
+ Shift amount to get the write data support
+
+``NVME_CMBSZ_SZU_SHIFT``
+ Shift amount to get the size units
+
+``NVME_CMBSZ_SZ_SHIFT``
+ Shift amount to get the size
+
+``NVME_CMBSZ_SQS_MASK``
+ Mask to get the submission queue support
+
+``NVME_CMBSZ_CQS_MASK``
+ Mask to get the completion queue support
+
+``NVME_CMBSZ_LISTS_MASK``
+ Mask to get the PLP SGL list support
+
+``NVME_CMBSZ_RDS_MASK``
+ Mask to get the read data support
+
+``NVME_CMBSZ_WDS_MASK``
+ Mask to get the write data support
+
+``NVME_CMBSZ_SZU_MASK``
+ Mask to get the size units
+
+``NVME_CMBSZ_SZ_MASK``
+ Mask to get the size
+
+``NVME_CMBSZ_SZU_4K``
+ 4 KiB
+
+``NVME_CMBSZ_SZU_64K``
+ 64 KiB
+
+``NVME_CMBSZ_SZU_1M``
+ 1 MiB
+
+``NVME_CMBSZ_SZU_16M``
+ 16 MiB
+
+``NVME_CMBSZ_SZU_256M``
+ 256 MiB
+
+``NVME_CMBSZ_SZU_4G``
+ 4 GiB
+
+``NVME_CMBSZ_SZU_64G``
+ 64 GiB
+
+
.. c:function:: __u64 nvme_cmb_size (__u32 cmbsz)
- Calculate size of the controller memory buffer
+ Calculate size of the controller memory buffer
+
+**Parameters**
+
+``__u32 cmbsz``
+ Value from controller register ``NVME_REG_CMBSZ``
+
+**Return**
+
+size of controller memory buffer in bytes
+
+
+
+
+.. c:enum:: nvme_bpinfo
+
+ This field indicates the boot partition information
+
+**Constants**
+
+``NVME_BPINFO_BPSZ_SHIFT``
+ Shift amount to get the boot partition size
+
+``NVME_BPINFO_BRS_SHIFT``
+ Shift amount to get the boot read status
+
+``NVME_BPINFO_ABPID_SHIFT``
+ Shift amount to get the active boot partition ID
+
+``NVME_BPINFO_BPSZ_MASK``
+ Mask to get the boot partition size
+
+``NVME_BPINFO_BRS_MASK``
+ Mask to get the boot read status
+
+``NVME_BPINFO_ABPID_MASK``
+ Mask to get the active boot partition ID
+
+``NVME_BPINFO_BRS_NONE``
+ No boot partition read operation requested
+
+``NVME_BPINFO_BRS_READ_IN_PROGRESS``
+ Boot partition read in progress
+
+``NVME_BPINFO_BRS_READ_SUCCESS``
+ Boot partition read completed successfully
+
+``NVME_BPINFO_BRS_READ_ERROR``
+ Error completing boot partition read
+
+
+
+
+.. c:enum:: nvme_bprsel
+
+ This field indicates the boot partition read select
+
+**Constants**
+
+``NVME_BPRSEL_BPRSZ_SHIFT``
+ Shift amount to get the boot partition read size
+
+``NVME_BPRSEL_BPROF_SHIFT``
+ Shift amount to get the boot partition read offset
+
+``NVME_BPRSEL_BPID_SHIFT``
+ Shift amount to get the boot partition identifier
+
+``NVME_BPRSEL_BPRSZ_MASK``
+ Mask to get the boot partition read size
+
+``NVME_BPRSEL_BPROF_MASK``
+ Mask to get the boot partition read offset
+
+``NVME_BPRSEL_BPID_MASK``
+ Mask to get the boot partition identifier
+
+
+
+
+.. c:enum:: nvme_bpmbl
+
+ This field indicates the boot partition memory buffer location
+
+**Constants**
+
+``NVME_BPMBL_BMBBA_SHIFT``
+ Shift amount to get the boot partition memory buffer base address
+
+
+
+
+.. c:enum:: nvme_cmbmsc
+
+ This field indicates the controller memory buffer memory space control
+
+**Constants**
+
+``NVME_CMBMSC_CRE_SHIFT``
+ Shift amount to get the capabilities registers enabled
+
+``NVME_CMBMSC_CMSE_SHIFT``
+ Shift amount to get the controller memory space enable
+
+``NVME_CMBMSC_CBA_SHIFT``
+ Shift amount to get the controller base address
+
+``NVME_CMBMSC_CRE_MASK``
+ Mask to get the capabilities registers enabled
+
+``NVME_CMBMSC_CMSE_MASK``
+ Mask to get the controller memory space enable
+
+
+
+
+.. c:enum:: nvme_cmbsts
+
+ This field indicates the controller memory buffer status
+
+**Constants**
+
+``NVME_CMBSTS_CBAI_SHIFT``
+ Shift amount to get the controller base address invalid
+
+``NVME_CMBSTS_CBAI_MASK``
+ Mask to get the controller base address invalid
+
+
+
+
+.. c:enum:: nvme_unit
+
+ Defined buffer size and write throughput granularity units
+
+**Constants**
+
+``NVME_UNIT_B``
+ Bytes or Bytes/second
+
+``NVME_UNIT_1K``
+ 1 KiB or 1 KiB/second
+
+``NVME_UNIT_1M``
+ 1 MiB or 1 MiB/second
+
+``NVME_UNIT_1G``
+ 1 GiB or 1 GiB/second
+
+
+
-**Parameters**
+.. c:enum:: nvme_cmbebs
-``__u32 cmbsz``
- Value from controller register ``NVME_REG_CMBSZ``
+ This field indicates the controller memory buffer elasticity buffer size
-**Return**
+**Constants**
-size of controller memory buffer in bytes
+``NVME_CMBEBS_CMBSZU_SHIFT``
+ Shift amount to get the CMB elasticity buffer size units
+
+``NVME_CMBEBS_RBB_SHIFT``
+ Shift amount to get the read bypass behavior
+
+``NVME_CMBEBS_CMBWBZ_SHIFT``
+ Shift amount to get the CMB elasiticity buffer size base
+
+``NVME_CMBEBS_CMBSZU_MASK``
+ Mask to get the CMB elasticity buffer size units
+
+``NVME_CMBEBS_RBB_MASK``
+ Mask to get the read bypass behavior
+
+``NVME_CMBEBS_CMBWBZ_MASK``
+ Mask to get the CMB elasiticity buffer size base
+
+``NVME_CMBEBS_CMBSZU_B``
+ Bytes granularity
+
+``NVME_CMBEBS_CMBSZU_1K``
+ 1 KiB granularity
+
+``NVME_CMBEBS_CMBSZU_1M``
+ 1 MiB granularity
+
+``NVME_CMBEBS_CMBSZU_1G``
+ 1 GiB granularity
+
+
+
+
+.. c:enum:: nvme_cmbswtp
+
+ This field indicates the controller memory buffer sustained write throughput
+
+**Constants**
+
+``NVME_CMBSWTP_CMBSWTU_SHIFT``
+ Shift amount to get the CMB sustained write throughput units
+
+``NVME_CMBSWTP_CMBSWTV_SHIFT``
+ Shift amount to get the CMB sustained write throughput
+
+``NVME_CMBSWTP_CMBSWTU_MASK``
+ Mask to get the CMB sustained write throughput units
+
+``NVME_CMBSWTP_CMBSWTV_MASK``
+ Mask to get the CMB sustained write throughput
+
+``NVME_CMBSWTP_CMBSWTU_B``
+ Bytes/second granularity
+
+``NVME_CMBSWTP_CMBSWTU_1K``
+ 1 KiB/second granularity
+
+``NVME_CMBSWTP_CMBSWTU_1M``
+ 1 MiB/second granularity
+
+``NVME_CMBSWTP_CMBSWTU_1G``
+ 1 GiB/second granularity
+
+
+
+
+.. c:enum:: nvme_crto
+
+ This field indicates the controller ready timeouts
+
+**Constants**
+
+``NVME_CRTO_CRWMT_SHIFT``
+ Shift amount to get the controller ready with media timeout
+
+``NVME_CRTO_CRIMT_SHIFT``
+ Shift amount to get the controller ready independent of media timeout
+
+``NVME_CRTO_CRWMT_MASK``
+ Mask to get the controller ready with media timeout
+
+``NVME_CRTO_CRIMT_MASK``
+ Mask to get the controller ready independent of media timeout
+
+
+
+
+.. c:enum:: nvme_pmrcap
+
+ This field indicates the persistent memory region capabilities
+
+**Constants**
+
+``NVME_PMRCAP_RDS_SHIFT``
+ Shift amount to get the read data support
+
+``NVME_PMRCAP_WDS_SHIFT``
+ Shift amount to get the write data support
+
+``NVME_PMRCAP_BIR_SHIFT``
+ Shift amount to get the base indicator register
+
+``NVME_PMRCAP_PMRTU_SHIFT``
+ Shift amount to get the persistent memory region time units
+
+``NVME_PMRCAP_PMRWBM_SHIFT``
+ Shift amount to get the persistent memory region write barrier mechanisms
+
+``NVME_PMRCAP_PMRTO_SHIFT``
+ Shift amount to get the persistent memory region timeout
+
+``NVME_PMRCAP_CMSS_SHIFT``
+ Shift amount to get the controller memory space supported
+
+``NVME_PMRCAP_PMRWMB_SHIFT``
+ Deprecated shift amount to get the persistent memory region write barrier mechanisms
+
+``NVME_PMRCAP_RDS_MASK``
+ Mask to get the read data support
+
+``NVME_PMRCAP_WDS_MASK``
+ Mask to get the write data support
+
+``NVME_PMRCAP_BIR_MASK``
+ Mask to get the base indicator register
+
+``NVME_PMRCAP_PMRTU_MASK``
+ Mask to get the persistent memory region time units
+
+``NVME_PMRCAP_PMRWBM_MASK``
+ Mask to get the persistent memory region write barrier mechanisms
+
+``NVME_PMRCAP_PMRTO_MASK``
+ Mask to get the persistent memory region timeout
+
+``NVME_PMRCAP_CMSS_MASK``
+ Mask to get the controller memory space supported
+
+``NVME_PMRCAP_PMRWMB_MASK``
+ Deprecated mask to get the persistent memory region write barrier mechanisms
+
+``NVME_PMRCAP_PMRTU_500MS``
+ 500 milliseconds
+
+``NVME_PMRCAP_PMRTU_60S``
+ minutes
+
+
+
+
+.. c:enum:: nvme_pmrctl
+
+ This field indicates the persistent memory region control
+
+**Constants**
+
+``NVME_PMRCTL_EN_SHIFT``
+ Shift amount to get the enable
+
+``NVME_PMRCTL_EN_MASK``
+ Mask to get the enable
+
+
+
+
+.. c:enum:: nvme_pmrsts
+
+ This field indicates the persistent memory region status
+
+**Constants**
+
+``NVME_PMRSTS_ERR_SHIFT``
+ Shift amount to get the error
+
+``NVME_PMRSTS_NRDY_SHIFT``
+ Shift amount to get the not ready
+
+``NVME_PMRSTS_HSTS_SHIFT``
+ Shift amount to get the health status
+
+``NVME_PMRSTS_CBAI_SHIFT``
+ Shift amount to get the controller base address invalid
+
+``NVME_PMRSTS_ERR_MASK``
+ Mask to get the error
+
+``NVME_PMRSTS_NRDY_MASK``
+ Mask to get the not ready
+
+``NVME_PMRSTS_HSTS_MASK``
+ Mask to get the health status
+
+``NVME_PMRSTS_CBAI_MASK``
+ Mask to get the controller base address invalid
+
+
+
+
+.. c:enum:: nvme_pmrebs
+
+ This field indicates the persistent memory region elasticity buffer size
+
+**Constants**
+
+``NVME_PMREBS_PMRSZU_SHIFT``
+ Shift amount to get the PMR elasticity buffer size units
+
+``NVME_PMREBS_RBB_SHIFT``
+ Shift amount to get the read bypass behavior
+
+``NVME_PMREBS_PMRWBZ_SHIFT``
+ Shift amount to get the PMR elasticity buffer size base
+
+``NVME_PMREBS_PMRSZU_MASK``
+ Mask to get the PMR elasticity buffer size units
+
+``NVME_PMREBS_RBB_MASK``
+ Mask to get the read bypass behavior
+
+``NVME_PMREBS_PMRWBZ_MASK``
+ Mask to get the PMR elasticity buffer size base
+
+``NVME_PMREBS_PMRSZU_B``
+ Bytes
+
+``NVME_PMREBS_PMRSZU_1K``
+ 1 KiB
+
+``NVME_PMREBS_PMRSZU_1M``
+ 1 MiB
+
+``NVME_PMREBS_PMRSZU_1G``
+ 1 GiB
.. c:function:: __u64 nvme_pmr_size (__u32 pmrebs)
size of controller persistent memory buffer in bytes
+
+
+.. c:enum:: nvme_pmrswtp
+
+ This field indicates the persistent memory region sustained write throughput
+
+**Constants**
+
+``NVME_PMRSWTP_PMRSWTU_SHIFT``
+ Shift amount to get the PMR sustained write throughput units
+
+``NVME_PMRSWTP_PMRSWTV_SHIFT``
+ Shift amount to get the PMR sustained write throughput
+
+``NVME_PMRSWTP_PMRSWTU_MASK``
+ Mask to get the PMR sustained write throughput units
+
+``NVME_PMRSWTP_PMRSWTV_MASK``
+ Mask to get the PMR sustained write throughput
+
+``NVME_PMRSWTP_PMRSWTU_BPS``
+ Bytes per second
+
+``NVME_PMRSWTP_PMRSWTU_KBPS``
+ 1 KiB / s
+
+``NVME_PMRSWTP_PMRSWTU_MBPS``
+ 1 MiB / s
+
+``NVME_PMRSWTP_PMRSWTU_GBPS``
+ 1 GiB / s
+
+
.. c:function:: __u64 nvme_pmr_throughput (__u32 pmrswtp)
Calculate throughput of persistent memory buffer
+.. c:enum:: nvme_pmrmsc
+
+ This field indicates the persistent memory region memory space control
+
+**Constants**
+
+``NVME_PMRMSC_CMSE_SHIFT``
+ Shift amount to get the controller memory space enable
+
+``NVME_PMRMSC_CBA_SHIFT``
+ Shift amount to get the controller base address
+
+``NVME_PMRMSC_CMSE_MASK``
+ Mask to get the controller memory space enable
+
+
+
+
+.. c:enum:: nvme_flbas
+
+ This field indicates the formatted LBA size
+
+**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
+
+
+
+
.. c:enum:: nvme_psd_flags
Possible flag values in nvme power state descriptor
+.. c:enum:: nvme_cmic
+
+ This field indicates the controller multi-path I/O and NS sharing capabilities
+
+**Constants**
+
+``NVME_CMIC_MULTI_PORT_SHIFT``
+ Shift amount to get the NVM subsystem port
+
+``NVME_CMIC_MULTI_CTRL_SHIFT``
+ Shift amount to get the controllers
+
+``NVME_CMIC_MULTI_SRIOV_SHIFT``
+ Shift amount to get the SR-IOV virtual function
+
+``NVME_CMIC_MULTI_ANA_SHIFT``
+ Shift amount to get the asymmetric namespace access reporting
+
+``NVME_CMIC_MULTI_RSVD_SHIFT``
+ Shift amount to get the reserved
+
+``NVME_CMIC_MULTI_PORT_MASK``
+ Mask to get the NVM subsystem port
+
+``NVME_CMIC_MULTI_CTRL_MASK``
+ Mask to get the controllers
+
+``NVME_CMIC_MULTI_SRIOV_MASK``
+ Mask to get the SR-IOV virtual function
+
+``NVME_CMIC_MULTI_ANA_MASK``
+ Mask to get the asymmetric namespace access reporting
+
+``NVME_CMIC_MULTI_RSVD_MASK``
+ Mask to get the reserved
+
+
+
+
.. c:enum:: nvme_id_ctrl_cmic
Controller Multipath IO and Namespace Sharing Capabilities of the controller and NVM subsystem.
+.. c:enum:: nvme_pel_rci
+
+ This field indicates the persistent event log reporting context
+
+**Constants**
+
+``NVME_PEL_RCI_RCPID_SHIFT``
+ Shift amount to get the reporting context port identifier
+ from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
+
+``NVME_PEL_RCI_RCPIT_SHIFT``
+ Shift amount to get the reporting context port identifier
+ type from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
+
+``NVME_PEL_RCI_RCE_SHIFT``
+ Shift amount to get the reporting context exists
+ from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
+
+``NVME_PEL_RCI_RSVD_SHIFT``
+ Shift amount to get the reserved reporting context
+ from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
+
+``NVME_PEL_RCI_RCPID_MASK``
+ Mask to get the reporting context port identifier from
+ the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
+
+``NVME_PEL_RCI_RCPIT_MASK``
+ Mask to get the reporting context port identifier type from
+ the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
+
+``NVME_PEL_RCI_RCE_MASK``
+ Mask to get the reporting context exists from
+ the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
+
+``NVME_PEL_RCI_RSVD_MASK``
+ Mask to get the reserved reporting context from
+ the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
+
+
+
+
+.. c:enum:: nvme_pel_rci_rcpit
+
+ Persistent Event Log Reporting Context - Port Identifier Type
+
+**Constants**
+
+``NVME_PEL_RCI_RCPIT_NOT_EXIST``
+ Does not already exist
+
+``NVME_PEL_RCI_RCPIT_EST_PORT``
+ Established by an NVM subsystem port
+
+``NVME_PEL_RCI_RCPIT_EST_ME``
+ Established by a Management Endpoint
+
+
+
+
.. c:struct:: nvme_persistent_event_entry
Persistent Event
+.. c:enum:: nvme_pel_ehai
+
+ This field indicates the persistent event header additional information
+
+**Constants**
+
+``NVME_PEL_EHAI_PIT_SHIFT``
+ Shift amount to get the reporting context port identifier
+ from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
+
+``NVME_PEL_EHAI_RSVD_SHIFT``
+ Shift amount to get the reserved reporting context
+ from the :c:type:`struct nvme_persistent_event_log <nvme_persistent_event_log>`.rci field.
+
+``NVME_PEL_EHAI_PIT_MASK``
+ Mask to get the reporting context port identifier from
+ the :c:type:`struct nvme_st_result <nvme_st_result>`.dsts field.
+
+``NVME_PEL_EHAI_RSVD_MASK``
+ Mask to get the reserved reporting context from
+ the :c:type:`struct nvme_st_result <nvme_st_result>`.dsts field.
+
+
+
+
+.. c:enum:: nvme_pel_ehai_pit
+
+ Persistent Event Header Additional Information - Port Identifier Type
+
+**Constants**
+
+``NVME_PEL_EHAI_PIT_NOT_REPORTED``
+ PIT not reported and PELPID does not apply
+
+``NVME_PEL_EHAI_PIT_NSS_PORT``
+ NVM subsystem port
+
+``NVME_PEL_EHAI_PIT_NMI_PORT``
+ NVMe-MI port
+
+``NVME_PEL_EHAI_PIT_NOT_ASSOCIATED``
+ Event not associated with any port and PELPID does not apply
+
+
+
+
.. c:struct:: nvme_fw_commit_event
Firmware Commit Event Data
+.. c:enum:: nvme_set_feat_event_layout
+
+ This field indicates the set feature event layout
+
+**Constants**
+
+``NVME_SET_FEAT_EVENT_DW_COUNT_SHIFT``
+ Shift amount to get the Dword count from the
+ :c:type:`struct nvme_set_feature_event <nvme_set_feature_event>`.layout field.
+
+``NVME_SET_FEAT_EVENT_CC_DW0_SHIFT``
+ Shift amount to get the logged command completion Dword 0
+ from the :c:type:`struct nvme_set_feature_event <nvme_set_feature_event>`.layout field.
+
+``NVME_SET_FEAT_EVENT_MB_COUNT_SHIFT``
+ Shift amount to get the memory buffer count from
+ the :c:type:`struct nvme_set_feature_event <nvme_set_feature_event>`.layout field.
+
+``NVME_SET_FEAT_EVENT_DW_COUNT_MASK``
+ Mask to get the Dword count from the :c:type:`struct
+ nvme_set_feature_event <nvme_set_feature_event>`.layout field.
+
+``NVME_SET_FEAT_EVENT_CC_DW0_MASK``
+ Mask to get the logged command completion Dword 0 from
+ the :c:type:`struct nvme_set_feature_event <nvme_set_feature_event>`.layout field.
+
+``NVME_SET_FEAT_EVENT_MB_COUNT_MASK``
+ Mask to get the memory buffer count from the :c:type:`struct
+ nvme_set_feature_event <nvme_set_feature_event>`.layout field.
+
+
+
+
.. c:struct:: nvme_thermal_exc_event
Thermal Excursion Event Data
+.. c:enum:: nvme_boot_partition_info
+
+ This field indicates the boot partition information
+
+**Constants**
+
+``NVME_BOOT_PARTITION_INFO_BPSZ_SHIFT``
+ Shift amount to get the boot partition size from
+ the :c:type:`struct nvme_boot_partition <nvme_boot_partition>`.bpinfo field.
+
+``NVME_BOOT_PARTITION_INFO_ABPID_SHIFT``
+ Shift amount to get the active boot partition ID
+ from the :c:type:`struct nvme_boot_partition <nvme_boot_partition>`.bpinfo field.
+
+``NVME_BOOT_PARTITION_INFO_BPSZ_MASK``
+ Mask to get the boot partition size from the
+ :c:type:`struct nvme_boot_partition <nvme_boot_partition>`.bpinfo field.
+
+``NVME_BOOT_PARTITION_INFO_ABPID_MASK``
+ Mask to get the active boot partition ID from the
+ :c:type:`struct nvme_boot_partition <nvme_boot_partition>`.bpinfo field.
+
+
+
+
.. c:struct:: nvme_eom_lane_desc
EOM Lane Descriptor
-.. c:enum:: nvme_eom_optional_data
+.. c:enum:: nvme_eom_optional_data_present
EOM Optional Data Present Fields
**Constants**
-``NVME_EOM_EYE_DATA_PRESENT``
- Eye Data Present
+``NVME_EOM_ODP_PEFP_SHIFT``
+ Shift amount to get the printable eye field present
+ from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
+
+``NVME_EOM_ODP_EDFP_SHIFT``
+ Shift amount to get the eye data field present
+ from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
+
+``NVME_EOM_ODP_RSVD_SHIFT``
+ Shift amount to get the reserved optional data present
+ from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
+
+``NVME_EOM_ODP_PEFP_MASK``
+ Mask to get the printable eye field present
+ from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
+
+``NVME_EOM_ODP_EDFP_MASK``
+ Mask to get the eye data field present
+ from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
+
+``NVME_EOM_ODP_RSVD_MASK``
+ Mask to get the reserved data present
+ from the :c:type:`struct nvme_phy_rx_eom_log <nvme_phy_rx_eom_log>`.odp field.
+
+
+
+
+.. c:enum:: nvme_eom_optional_data
+
+ EOM Optional Data Present Fields (Deprecated)
+
+**Constants**
``NVME_EOM_PRINTABLE_EYE_PRESENT``
Printable Eye Present
+``NVME_EOM_EYE_DATA_PRESENT``
+ Eye Data Present
+
``NVME_LOG_LID_MI_CMD_SUPPORTED_EFFECTS``
NVMe-MI Commands Supported and Effects
+``NVME_LOG_LID_CMD_AND_FEAT_LOCKDOWN``
+ Command and Feature Lockdown
+
``NVME_LOG_LID_BOOT_PARTITION``
Boot Partition