nvme/libnvme
1
0
Fork 0
Code Issues Activity

Merging upstream version 1.1~rc0.

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-16 10:03:28 +01:00
parent 537ee18b08
commit 73281abe5f
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
764 changed files with 32602 additions and 5874 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/man/nvme_admin_opcode.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_admin_opcode" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_admin_opcode" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_admin_opcode \- Known NVMe admin opcodes
.SH SYNOPSIS

8
doc/man/nvme_admin_passthru.2
View file

@ -1,4 +1,4 @@
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "April 2022" "libnvme API manual" LINUX
.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_admin_passthru \- Submit an nvme passthrough command
.SH SYNOPSIS
@ -30,7 +30,7 @@ The nvme io command to send
.IP "flags" 12
NVMe command flags (not used)
.IP "rsvd" 12
Reserevd for future use
Reserved for future use
.IP "nsid" 12
Namespace identifier
.IP "cdw2" 12
@ -50,11 +50,11 @@ Command dword 14
.IP "cdw15" 12
Command dword 15
.IP "data_len" 12
Length of the data transfered in this command in bytes
Length of the data transferred in this command in bytes
.IP "data" 12
Pointer to user address of the data buffer
.IP "metadata_len" 12
Length of metadata transfered in this command
Length of metadata transferred in this command
.IP "metadata" 12
Pointer to user address of the metadata buffer
.IP "timeout_ms" 12

4
doc/man/nvme_ae_info_css_nvm.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_css_nvm \-
enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
.SH SYNOPSIS
enum nvme_ae_info_css_nvm {
.br

4
doc/man/nvme_ae_info_error.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_ae_info_error" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_error" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_error \-
enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
.SH SYNOPSIS
enum nvme_ae_info_error {
.br

4
doc/man/nvme_ae_info_notice.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_ae_info_notice" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_notice" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_notice \-
enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
.SH SYNOPSIS
enum nvme_ae_info_notice {
.br

4
doc/man/nvme_ae_info_smart.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_ae_info_smart" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_info_smart" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_ae_info_smart \-
enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
.SH SYNOPSIS
enum nvme_ae_info_smart {
.br

4
doc/man/nvme_ae_type.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_ae_type" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ae_type" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_ae_type \-
enum nvme_ae_type \- Asynchronous Event Type
.SH SYNOPSIS
enum nvme_ae_type {
.br

4
doc/man/nvme_aggregate_endurance_group_event.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_aggregate_endurance_group_event \-
struct nvme_aggregate_endurance_group_event \- Endurance Group Event Aggregate
.SH SYNOPSIS
struct nvme_aggregate_endurance_group_event {
.br

4
doc/man/nvme_aggregate_predictable_lat_event.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_aggregate_predictable_lat_event \-
struct nvme_aggregate_predictable_lat_event \- Predictable Latency Event Aggregate Log Page
.SH SYNOPSIS
struct nvme_aggregate_predictable_lat_event {
.br

4
doc/man/nvme_ana_group_desc.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "struct nvme_ana_group_desc" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_ana_group_desc" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_ana_group_desc \-
struct nvme_ana_group_desc \- ANA Group Descriptor
.SH SYNOPSIS
struct nvme_ana_group_desc {
.br

4
doc/man/nvme_ana_log.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "struct nvme_ana_log" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_ana_log" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_ana_log \-
struct nvme_ana_log \- Asymmetric Namespace Access Log
.SH SYNOPSIS
struct nvme_ana_log {
.br

9
doc/man/nvme_ana_state.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_ana_state" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ana_state" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_ana_state \-
enum nvme_ana_state \- ANA Group Descriptor - Asymmetric Namespace Access State
.SH SYNOPSIS
enum nvme_ana_state {
.br
@ -25,7 +25,12 @@ enum nvme_ana_state {
};
.SH Constants
.IP "NVME_ANA_STATE_OPTIMIZED" 12
ANA Optimized state
.IP "NVME_ANA_STATE_NONOPTIMIZED" 12
ANA Non-Optimized state
.IP "NVME_ANA_STATE_INACCESSIBLE" 12
ANA Inaccessible state
.IP "NVME_ANA_STATE_PERSISTENT_LOSS" 12
ANA Persistent Loss state
.IP "NVME_ANA_STATE_CHANGE" 12
ANA Change state

8
doc/man/nvme_apst_entry.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_apst_entry" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_apst_entry" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_apst_entry \-
enum nvme_apst_entry \- Autonomous Power State Transition
.SH SYNOPSIS
enum nvme_apst_entry {
.br
@ -21,6 +21,10 @@ enum nvme_apst_entry {
};
.SH Constants
.IP "NVME_APST_ENTRY_ITPS_SHIFT" 12
Idle Transition Power State Shift
.IP "NVME_APST_ENTRY_ITPT_SHIFT" 12
Idle Time Prior to Transition Shift
.IP "NVME_APST_ENTRY_ITPS_MASK" 12
Idle Transition Power State Mask
.IP "NVME_APST_ENTRY_ITPT_MASK" 12
Idle Time Prior to Transition Mask

4
doc/man/nvme_boot_partition.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "struct nvme_boot_partition" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_boot_partition" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_boot_partition \-
struct nvme_boot_partition \- Boot Partition Log
.SH SYNOPSIS
struct nvme_boot_partition {
.br

0
doc/man/nvme_cap_config_desc.2
View file

33
doc/man/nvme_capacity_config_desc.2 Normal file
View file

@ -0,0 +1,33 @@
.TH "libnvme" 9 "struct nvme_capacity_config_desc" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_capacity_config_desc \- Capacity Configuration structure definitions
.SH SYNOPSIS
struct nvme_capacity_config_desc {
.br
.BI " __le16 cap_config_id;"
.br
.BI " __le16 domainid;"
.br
.BI " __le16 egcn;"
.br
.BI " __u8 rsvd6[26];"
.br
.BI " struct nvme_end_grp_config_desc egcd[];"
.br
.BI "
};
.br
.SH Members
.IP "cap_config_id" 12
Capacity Configuration Identifier
.IP "domainid" 12
Domain Identifier
.IP "egcn" 12
Number Endurance Group Configuration
Descriptors
.IP "rsvd6" 12
Reserved
.IP "egcd" 12
Endurance Group Config descriptors.
See \fIstruct\fP nvme_end_grp_config_desc

4
doc/man/nvme_capacity_mgmt.2
View file

@ -1,6 +1,6 @@
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "April 2022" "libnvme API manual" LINUX
.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_capacity_mgmt \-
nvme_capacity_mgmt \- Capacity management command
.SH SYNOPSIS
.B "int" nvme_capacity_mgmt
.BI "(struct nvme_capacity_mgmt_args *args " ");"

45
doc/man/nvme_capacity_mgmt_args.2
View file

@ -1,45 +0,0 @@
.TH "libnvme" 9 "struct nvme_capacity_mgmt_args" "April 2022" "API Manual" LINUX
.SH NAME
struct nvme_capacity_mgmt_args \- Arguments for the NVMe Capacity Management command
.SH SYNOPSIS
struct nvme_capacity_mgmt_args {
.br
.BI " __u32 *result;"
.br
.BI " int args_size;"
.br
.BI " int fd;"
.br
.BI " __u32 timeout;"
.br
.BI " __u32 cdw11;"
.br
.BI " __u32 cdw12;"
.br
.BI " __u16 element_id;"
.br
.BI " __u8 op;"
.br
.BI "
};
.br
.SH Members
.IP "result" 12
If successful, the CQE dword0 value
.IP "args_size" 12
Size of \fIstruct nvme_capacity_mgmt_args\fP
.IP "fd" 12
File descriptor of nvme device
.IP "timeout" 12
Timeout in ms
.IP "cdw11" 12
Least significant 32 bits of the capacity in bytes of the
Endurance Group or NVM Set to be created
.IP "cdw12" 12
Most significant 32 bits of the capacity in bytes of the
Endurance Group or NVM Set to be created
.IP "element_id" 12
Value specific to the value of the Operation field
.IP "op" 12
Operation to be performed by the controller

4
doc/man/nvme_change_ns_event.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "struct nvme_change_ns_event" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_change_ns_event" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_change_ns_event \-
struct nvme_change_ns_event \- Change Namespace Event Data
.SH SYNOPSIS
struct nvme_change_ns_event {
.br

10
doc/man/nvme_channel_config_desc.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "struct nvme_channel_config_desc" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_channel_config_desc" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_channel_config_desc \-
struct nvme_channel_config_desc \- Channel Configuration Descriptor
.SH SYNOPSIS
struct nvme_channel_config_desc {
.br
@ -19,6 +19,6 @@ struct nvme_channel_config_desc {
Channel Identifier
.IP "chmus" 12
Number Channel Media Units
.SH "Description"
Channel Configuration Descriptor
Structure Definitions
.IP "mu_config_desc" 12
Channel Unit config descriptors.
See \fIstruct\fP nvme_media_unit_config_desc

6
doc/man/nvme_cmb_size.2
View file

@ -1,4 +1,4 @@
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "April 2022" "libnvme API manual" LINUX
.TH "nvme_cmb_size" 9 "nvme_cmb_size" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_cmb_size \- Calculate size of the controller memory buffer
.SH SYNOPSIS
@ -7,5 +7,5 @@ nvme_cmb_size \- Calculate size of the controller memory buffer
.SH ARGUMENTS
.IP "cmbsz" 12
Value from controller register NVME_REG_CMBSZ
.SH "DESCRIPTION"
Returns size of controller memory buffer in bytes
.SH "RETURN"
size of controller memory buffer in bytes

4
doc/man/nvme_cmd_effects.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_cmd_effects" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_effects" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_cmd_effects \-
enum nvme_cmd_effects \- Commands Supported and Effects
.SH SYNOPSIS
enum nvme_cmd_effects {
.br

4
doc/man/nvme_cmd_effects_log.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_cmd_effects_log" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_cmd_effects_log \-
struct nvme_cmd_effects_log \- Commands Supported and Effects Log
.SH SYNOPSIS
struct nvme_cmd_effects_log {
.br

2
doc/man/nvme_cmd_format_mset.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_mset" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_mset \- Format NVM - Metadata Settings
.SH SYNOPSIS

2
doc/man/nvme_cmd_format_pi.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_pi" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_pi" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_pi \- Format NVM - Protection Information
.SH SYNOPSIS

2
doc/man/nvme_cmd_format_pil.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_pil" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_pil" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_pil \- Format NVM - Protection Information Location
.SH SYNOPSIS

2
doc/man/nvme_cmd_format_ses.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_cmd_format_ses" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_format_ses" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_cmd_format_ses \- Format NVM - Secure Erase Settings
.SH SYNOPSIS

4
doc/man/nvme_cmd_get_log_lid.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_cmd_get_log_lid \-
enum nvme_cmd_get_log_lid \- Get Log Page -Log Page Identifiers
.SH SYNOPSIS
enum nvme_cmd_get_log_lid {
.br

6
doc/man/nvme_cmd_get_log_telemetry_host_lsp.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_cmd_get_log_telemetry_host_lsp \-
enum nvme_cmd_get_log_telemetry_host_lsp \- Telemetry Host-Initiated log specific field
.SH SYNOPSIS
enum nvme_cmd_get_log_telemetry_host_lsp {
.br
@ -13,4 +13,6 @@ enum nvme_cmd_get_log_telemetry_host_lsp {
};
.SH Constants
.IP "NVME_LOG_TELEM_HOST_LSP_RETAIN" 12
Get Telemetry Data Blocks
.IP "NVME_LOG_TELEM_HOST_LSP_CREATE" 12
Create Telemetry Data Blocks

2
doc/man/nvme_compare.2
View file

@ -1,4 +1,4 @@
.TH "nvme_compare" 9 "nvme_compare" "April 2022" "libnvme API manual" LINUX
.TH "nvme_compare" 9 "nvme_compare" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_compare \- Submit an nvme user compare command
.SH SYNOPSIS

32
doc/man/nvme_connect_err.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_connect_err" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_connect_err" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_connect_err \- nvme connect error codes
.SH SYNOPSIS
@ -49,6 +49,26 @@ enum nvme_connect_err {
.br
.br
.BI " ENVME_CONNECT_LOOKUP_SUBSYS"
,
.br
.br
.BI " ENVME_CONNECT_ALREADY"
,
.br
.br
.BI " ENVME_CONNECT_INVAL"
,
.br
.br
.BI " ENVME_CONNECT_ADDRINUSE"
,
.br
.br
.BI " ENVME_CONNECT_NODEV"
,
.br
.br
.BI " ENVME_CONNECT_OPNOTSUPP"
};
.SH Constants
@ -76,3 +96,13 @@ invalid transport type
failed to lookup subsystem name
.IP "ENVME_CONNECT_LOOKUP_SUBSYS" 12
failed to lookup subsystem
.IP "ENVME_CONNECT_ALREADY" 12
the connect attempt failed, already connected
.IP "ENVME_CONNECT_INVAL" 12
invalid arguments/configuration
.IP "ENVME_CONNECT_ADDRINUSE" 12
hostnqn already in use
.IP "ENVME_CONNECT_NODEV" 12
invalid interface
.IP "ENVME_CONNECT_OPNOTSUPP" 12
not supported

6
doc/man/nvme_constants.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_constants" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_constants" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_constants \- A place to stash various constant nvme values
.SH SYNOPSIS
@ -141,7 +141,7 @@ Use to omit a log lpo command parameter
.IP "NVME_IDENTIFY_DATA_SIZE" 12
The transfer size for nvme identify commands
.IP "NVME_LOG_SUPPORTED_LOG_PAGES_MAX" 12
The lagest possible index in the supported
The largest possible index in the supported
log pages log.
.IP "NVME_ID_NVMSET_LIST_MAX" 12
The largest possible nvmset index in identify
@ -177,7 +177,7 @@ device self test log
.IP "NVME_LOG_TELEM_BLOCK_SIZE" 12
Specification defined size of Telemetry Data Blocks
.IP "NVME_LOG_FID_SUPPORTED_EFFECTS_MAX" 12
The largest possible FID index in the
The largest possible FID index in the
feature identifiers effects log.
.IP "NVME_LOG_MI_CMD_SUPPORTED_EFFECTS_MAX" 12
The largest possible MI Command index

4
doc/man/nvme_copy.2
View file

@ -1,6 +1,6 @@
.TH "nvme_copy" 9 "nvme_copy" "April 2022" "libnvme API manual" LINUX
.TH "nvme_copy" 9 "nvme_copy" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_copy \-
nvme_copy \- Copy command
.SH SYNOPSIS
.B "int" nvme_copy
.BI "(struct nvme_copy_args *args " ");"

83
doc/man/nvme_copy_args.2
View file

@ -1,83 +0,0 @@
.TH "libnvme" 9 "struct nvme_copy_args" "April 2022" "API Manual" LINUX
.SH NAME
struct nvme_copy_args \- Arguments for the NVMe Copy command
.SH SYNOPSIS
struct nvme_copy_args {
.br
.BI " __u64 sdlba;"
.br
.BI " __u32 *result;"
.br
.BI " struct nvme_copy_range *copy;"
.br
.BI " int args_size;"
.br
.BI " int fd;"
.br
.BI " __u32 timeout;"
.br
.BI " __u32 nsid;"
.br
.BI " __u32 ilbrt;"
.br
.BI " int lr;"
.br
.BI " int fua;"
.br
.BI " __u16 nr;"
.br
.BI " __u16 dspec;"
.br
.BI " __u16 lbatm;"
.br
.BI " __u16 lbat;"
.br
.BI " __u8 prinfor;"
.br
.BI " __u8 prinfow;"
.br
.BI " __u8 dtype;"
.br
.BI " __u8 format;"
.br
.BI "
};
.br
.SH Members
.IP "sdlba" 12
Start destination LBA
.IP "result" 12
The command completion result from CQE dword0
.IP "copy" 12
Range descriptior
.IP "args_size" 12
Size of \fIstruct nvme_copy_args\fP
.IP "fd" 12
File descriptor of the nvme device
.IP "timeout" 12
Timeout in ms
.IP "nsid" 12
Namespace identifier
.IP "ilbrt" 12
Initial logical block reference tag
.IP "lr" 12
Limited retry
.IP "fua" 12
Force unit access
.IP "nr" 12
Number of ranges
.IP "dspec" 12
Directive specific value
.IP "lbatm" 12
Logical block application tag mask
.IP "lbat" 12
Logical block application tag
.IP "prinfor" 12
Protection information field for read
.IP "prinfow" 12
Protection information field for write
.IP "dtype" 12
Directive type
.IP "format" 12
Descriptor format

7
doc/man/nvme_copy_range.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "struct nvme_copy_range" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_copy_range" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_copy_range \-
struct nvme_copy_range \- Copy - Source Range Entries Descriptor Format
.SH SYNOPSIS
struct nvme_copy_range {
.br
@ -32,7 +32,8 @@ Number of Logical Blocks
.IP "rsvd18" 12
Reserved
.IP "eilbrt" 12
Expected Initial Logical Block Reference Tag
Expected Initial Logical Block Reference Tag /
Expected Logical Block Storage Tag
.IP "elbatm" 12
Expected Logical Block Application Tag Mask
.IP "elbat" 12

2
doc/man/nvme_create_ctrl.2
View file

@ -1,4 +1,4 @@
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "April 2022" "libnvme API manual" LINUX
.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_create_ctrl \- Allocate an unconnected NVMe controller
.SH SYNOPSIS

2
doc/man/nvme_create_root.2
View file

@ -1,4 +1,4 @@
.TH "nvme_create_root" 9 "nvme_create_root" "April 2022" "libnvme API manual" LINUX
.TH "nvme_create_root" 9 "nvme_create_root" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_create_root \- Initialize root object
.SH SYNOPSIS

2
doc/man/nvme_csi.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_csi" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_csi" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_csi \- Defined command set indicators
.SH SYNOPSIS

2
doc/man/nvme_ctrl_first_ns.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_first_ns \- Start namespace iterator
.SH SYNOPSIS

2
doc/man/nvme_ctrl_first_path.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_first_path \- Start path iterator
.SH SYNOPSIS

2
doc/man/nvme_ctrl_for_each_ns.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_ns \- Traverse namespaces
.SH SYNOPSIS

2
doc/man/nvme_ctrl_for_each_ns_safe.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_ns_safe \- Traverse namespaces
.SH SYNOPSIS

2
doc/man/nvme_ctrl_for_each_path.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_path \- Traverse paths
.SH SYNOPSIS

2
doc/man/nvme_ctrl_for_each_path_safe.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_for_each_path_safe \- Traverse paths
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_address.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_address \- Address string of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_config.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_config \- Fabrics configuration of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_dhchap_key.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_dhchap_key \- Return controller key
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_fd.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_fd \- Get associated file descriptor
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_firmware.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_firmware \- Firmware string of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_host_iface.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_host_iface \- Host interface name of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_host_traddr.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_host_traddr \- Host transport address of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_model.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_model \- Model of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_name.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_name \- sysfs name of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_numa_node.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_numa_node \- NUMA node of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_queue_count.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_queue_count \- Queue count of a controller
.SH SYNOPSIS

4
doc/man/nvme_ctrl_get_serial.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_serial \- Serial number of a controller
.SH SYNOPSIS
@ -6,6 +6,6 @@ nvme_ctrl_get_serial \- Serial number of a controller
.BI "(nvme_ctrl_t c " ");"
.SH ARGUMENTS
.IP "c" 12
Conroller instance
Controller instance
.SH "RETURN"
Serial number string of \fIc\fP

2
doc/man/nvme_ctrl_get_sqsize.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_sqsize \- SQ size of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_state.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_state \- Running state of an controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_subsysnqn.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_subsysnqn \- Subsystem NQN of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_subsystem.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_subsystem \- Parent subsystem of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_sysfs_dir.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_sysfs_dir \- sysfs directory of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_traddr.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_traddr \- Transport address of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_transport.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_transport \- Transport type of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_get_trsvcid.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_get_trsvcid \- Transport service identifier of a controller
.SH SYNOPSIS

2
doc/man/nvme_ctrl_identify.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_identify \- Issues an 'identify controller' command
.SH SYNOPSIS

2
doc/man/nvme_ctrl_is_discovered.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_discovered \- Returns the value of the 'discovered' flag
.SH SYNOPSIS

2
doc/man/nvme_ctrl_is_discovery_ctrl.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_discovery_ctrl \- Check the 'discovery_ctrl' flag
.SH SYNOPSIS

2
doc/man/nvme_ctrl_is_persistent.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_is_persistent \- Returns the value of the 'persistent' flag
.SH SYNOPSIS

4
doc/man/nvme_ctrl_list.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "struct nvme_ctrl_list" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "struct nvme_ctrl_list" "July 2022" "API Manual" LINUX
.SH NAME
struct nvme_ctrl_list \-
struct nvme_ctrl_list \- Controller List
.SH SYNOPSIS
struct nvme_ctrl_list {
.br

4
doc/man/nvme_ctrl_metadata_type.2
View file

@ -1,4 +1,4 @@
.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_ctrl_metadata_type \- Controller Metadata Element Types
.SH SYNOPSIS
@ -91,7 +91,7 @@ Model of the processor.
.IP "NVME_CTRL_METADATA_CHIPSET_DRV_NAME" 12
Chipset driver name.
.IP "NVME_CTRL_METADATA_CHIPSET_DRV_VERSION" 12
Chipsset driver version.
Chipset driver version.
.IP "NVME_CTRL_METADATA_OS_NAME_AND_BUILD" 12
Operating system name and build.
.IP "NVME_CTRL_METADATA_SYS_PROD_NAME" 12

2
doc/man/nvme_ctrl_next_ns.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_next_ns \- Next namespace iterator
.SH SYNOPSIS

2
doc/man/nvme_ctrl_next_path.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_next_path \- Next path iterator
.SH SYNOPSIS

2
doc/man/nvme_ctrl_reset.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_reset \- Initiate a controller reset
.SH SYNOPSIS

2
doc/man/nvme_ctrl_set_dhchap_key.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_dhchap_key \- Set controller key
.SH SYNOPSIS

2
doc/man/nvme_ctrl_set_discovered.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_discovered \- Set the 'discovered' flag
.SH SYNOPSIS

2
doc/man/nvme_ctrl_set_discovery_ctrl.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_discovery_ctrl \- Set the 'discovery_ctrl' flag
.SH SYNOPSIS

2
doc/man/nvme_ctrl_set_persistent.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrl_set_persistent \- Set the 'persistent' flag
.SH SYNOPSIS

2
doc/man/nvme_ctrls_filter.2
View file

@ -1,4 +1,4 @@
.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "April 2022" "libnvme API manual" LINUX
.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_ctrls_filter \- Filter for controllers
.SH SYNOPSIS

2
doc/man/nvme_default_host.2
View file

@ -1,4 +1,4 @@
.TH "nvme_default_host" 9 "nvme_default_host" "April 2022" "libnvme API manual" LINUX
.TH "nvme_default_host" 9 "nvme_default_host" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_default_host \- Initializes the default host
.SH SYNOPSIS

2
doc/man/nvme_dev_self_test.2
View file

@ -1,4 +1,4 @@
.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "April 2022" "libnvme API manual" LINUX
.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_dev_self_test \- Start or abort a self test
.SH SYNOPSIS

35
doc/man/nvme_dev_self_test_args.2
View file

@ -1,35 +0,0 @@
.TH "libnvme" 9 "struct nvme_dev_self_test_args" "April 2022" "API Manual" LINUX
.SH NAME
struct nvme_dev_self_test_args \- Arguments for the NVMe Device Self Test command
.SH SYNOPSIS
struct nvme_dev_self_test_args {
.br
.BI " __u32 *result;"
.br
.BI " int args_size;"
.br
.BI " int fd;"
.br
.BI " __u32 timeout;"
.br
.BI " __u32 nsid;"
.br
.BI " enum nvme_dst_stc stc;"
.br
.BI "
};
.br
.SH Members
.IP "result" 12
The command completion result from CQE dword0
.IP "args_size" 12
Size of \fIstruct nvme_dev_self_test_args\fP
.IP "fd" 12
File descriptor of nvme device
.IP "timeout" 12
Timeout in ms
.IP "nsid" 12
Namespace ID to test
.IP "stc" 12
Self test code, see \fIenum nvme_dst_stc\fP

39
doc/man/nvme_dim_args.2
View file

@ -1,39 +0,0 @@
.TH "libnvme" 9 "struct nvme_dim_args" "April 2022" "API Manual" LINUX
.SH NAME
struct nvme_dim_args \- Arguments for the Discovery Information Management (DIM) command
.SH SYNOPSIS
struct nvme_dim_args {
.br
.BI " __u32 *result;"
.br
.BI " void *data;"
.br
.BI " int args_size;"
.br
.BI " int fd;"
.br
.BI " __u32 timeout;"
.br
.BI " __u32 data_len;"
.br
.BI " __u8 tas;"
.br
.BI "
};
.br
.SH Members
.IP "result" 12
Set on completion to the command's CQE DWORD 0 controller response.
.IP "data" 12
Pointer to the DIM data
.IP "args_size" 12
Length of the structure
.IP "fd" 12
File descriptor of nvme device
.IP "timeout" 12
Timeout in ms
.IP "data_len" 12
Length of \fIdata\fP
.IP "tas" 12
Task field of the Command Dword 10 (cdw10)

4
doc/man/nvme_directive_dtype.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_directive_dtype" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_directive_dtype" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_directive_dtype \-
enum nvme_directive_dtype \- Directive Types
.SH SYNOPSIS
enum nvme_directive_dtype {
.br

4
doc/man/nvme_directive_receive_doper.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_directive_receive_doper" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_directive_receive_doper" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_directive_receive_doper \-
enum nvme_directive_receive_doper \- Directive Receive Directive Operation
.SH SYNOPSIS
enum nvme_directive_receive_doper {
.br

2
doc/man/nvme_directive_recv.2
View file

@ -1,4 +1,4 @@
.TH "nvme_directive_recv" 9 "nvme_directive_recv" "April 2022" "libnvme API manual" LINUX
.TH "nvme_directive_recv" 9 "nvme_directive_recv" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv \- Receive directive specific data
.SH SYNOPSIS

55
doc/man/nvme_directive_recv_args.2
View file

@ -1,55 +0,0 @@
.TH "libnvme" 9 "struct nvme_directive_recv_args" "April 2022" "API Manual" LINUX
.SH NAME
struct nvme_directive_recv_args \- Arguments for the NVMe Directive Receive command
.SH SYNOPSIS
struct nvme_directive_recv_args {
.br
.BI " __u32 *result;"
.br
.BI " void *data;"
.br
.BI " int args_size;"
.br
.BI " int fd;"
.br
.BI " __u32 timeout;"
.br
.BI " __u32 nsid;"
.br
.BI " enum nvme_directive_receive_doper doper;"
.br
.BI " enum nvme_directive_dtype dtype;"
.br
.BI " __u32 cdw12;"
.br
.BI " __u32 data_len;"
.br
.BI " __u16 dspec;"
.br
.BI "
};
.br
.SH Members
.IP "result" 12
If successful, the CQE dword0 value
.IP "data" 12
Usespace address of data payload
.IP "args_size" 12
Size of \fIstruct nvme_directive_recv_args\fP
.IP "fd" 12
File descriptor of nvme device
.IP "timeout" 12
Timeout in ms
.IP "nsid" 12
Namespace ID, if applicable
.IP "doper" 12
Directive send operation, see \fIenum nvme_directive_send_doper\fP
.IP "dtype" 12
Directive type, see \fIenum nvme_directive_dtype\fP
.IP "cdw12" 12
Directive specific command dword12
.IP "data_len" 12
Length of data payload in bytes
.IP "dspec" 12
Directive specific field

4
doc/man/nvme_directive_recv_identify_parameters.2
View file

@ -1,6 +1,6 @@
.TH "nvme_directive_recv_identify_parameters" 9 "nvme_directive_recv_identify_parameters" "April 2022" "libnvme API manual" LINUX
.TH "nvme_directive_recv_identify_parameters" 9 "nvme_directive_recv_identify_parameters" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv_identify_parameters \-
nvme_directive_recv_identify_parameters \- Directive receive identifier parameters
.SH SYNOPSIS
.B "int" nvme_directive_recv_identify_parameters
.BI "(int fd " ","

4
doc/man/nvme_directive_recv_stream_allocate.2
View file

@ -1,6 +1,6 @@
.TH "nvme_directive_recv_stream_allocate" 9 "nvme_directive_recv_stream_allocate" "April 2022" "libnvme API manual" LINUX
.TH "nvme_directive_recv_stream_allocate" 9 "nvme_directive_recv_stream_allocate" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv_stream_allocate \-
nvme_directive_recv_stream_allocate \- Directive receive stream allocate
.SH SYNOPSIS
.B "int" nvme_directive_recv_stream_allocate
.BI "(int fd " ","

4
doc/man/nvme_directive_recv_stream_parameters.2
View file

@ -1,6 +1,6 @@
.TH "nvme_directive_recv_stream_parameters" 9 "nvme_directive_recv_stream_parameters" "April 2022" "libnvme API manual" LINUX
.TH "nvme_directive_recv_stream_parameters" 9 "nvme_directive_recv_stream_parameters" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv_stream_parameters \-
nvme_directive_recv_stream_parameters \- Directive receive stream parameters
.SH SYNOPSIS
.B "int" nvme_directive_recv_stream_parameters
.BI "(int fd " ","

6
doc/man/nvme_directive_recv_stream_status.2
View file

@ -1,11 +1,11 @@
.TH "nvme_directive_recv_stream_status" 9 "nvme_directive_recv_stream_status" "April 2022" "libnvme API manual" LINUX
.TH "nvme_directive_recv_stream_status" 9 "nvme_directive_recv_stream_status" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_directive_recv_stream_status \-
nvme_directive_recv_stream_status \- Directive receive stream status
.SH SYNOPSIS
.B "int" nvme_directive_recv_stream_status
.BI "(int fd " ","
.BI "__u32 nsid " ","
.BI "unsigned nr_entries " ","
.BI "unsigned int nr_entries " ","
.BI "struct nvme_streams_directive_status *id " ");"
.SH ARGUMENTS
.IP "fd" 12

2
doc/man/nvme_directive_send.2
View file

@ -1,4 +1,4 @@
.TH "nvme_directive_send" 9 "nvme_directive_send" "April 2022" "libnvme API manual" LINUX
.TH "nvme_directive_send" 9 "nvme_directive_send" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_directive_send \- Send directive command
.SH SYNOPSIS

55
doc/man/nvme_directive_send_args.2
View file

@ -1,55 +0,0 @@
.TH "libnvme" 9 "struct nvme_directive_send_args" "April 2022" "API Manual" LINUX
.SH NAME
struct nvme_directive_send_args \- Arguments for the NVMe Directive Send command
.SH SYNOPSIS
struct nvme_directive_send_args {
.br
.BI " __u32 *result;"
.br
.BI " void *data;"
.br
.BI " int args_size;"
.br
.BI " int fd;"
.br
.BI " __u32 timeout;"
.br
.BI " __u32 nsid;"
.br
.BI " enum nvme_directive_send_doper doper;"
.br
.BI " enum nvme_directive_dtype dtype;"
.br
.BI " __u32 cdw12;"
.br
.BI " __u32 data_len;"
.br
.BI " __u16 dspec;"
.br
.BI "
};
.br
.SH Members
.IP "result" 12
If successful, the CQE dword0 value
.IP "data" 12
Data payload to to be send
.IP "args_size" 12
Size of \fIstruct nvme_directive_send_args\fP
.IP "fd" 12
File descriptor of nvme device
.IP "timeout" 12
Timeout in ms
.IP "nsid" 12
Namespace ID, if applicable
.IP "doper" 12
Directive send operation, see \fIenum nvme_directive_send_doper\fP
.IP "dtype" 12
Directive type, see \fIenum nvme_directive_dtype\fP
.IP "cdw12" 12
Directive specific command dword12
.IP "data_len" 12
Length of data payload in bytes
.IP "dspec" 12
Directive specific field

4
doc/man/nvme_directive_send_doper.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_directive_send_doper" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_directive_send_doper" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_directive_send_doper \-
enum nvme_directive_send_doper \- Directive Send Directive Operation
.SH SYNOPSIS
enum nvme_directive_send_doper {
.br

4
doc/man/nvme_directive_send_id_endir.2
View file

@ -1,6 +1,6 @@
.TH "nvme_directive_send_id_endir" 9 "nvme_directive_send_id_endir" "April 2022" "libnvme API manual" LINUX
.TH "nvme_directive_send_id_endir" 9 "nvme_directive_send_id_endir" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_directive_send_id_endir \-
nvme_directive_send_id_endir \- Directive Send Enable Directive
.SH SYNOPSIS
.B "int" nvme_directive_send_id_endir
.BI "(int fd " ","

4
doc/man/nvme_directive_send_identify_endir.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_directive_send_identify_endir" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_directive_send_identify_endir" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_directive_send_identify_endir \-
enum nvme_directive_send_identify_endir \- Enable Directive
.SH SYNOPSIS
enum nvme_directive_send_identify_endir {
.br

4
doc/man/nvme_directive_send_stream_release_identifier.2
View file

@ -1,6 +1,6 @@
.TH "nvme_directive_send_stream_release_identifier" 9 "nvme_directive_send_stream_release_identifier" "April 2022" "libnvme API manual" LINUX
.TH "nvme_directive_send_stream_release_identifier" 9 "nvme_directive_send_stream_release_identifier" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_directive_send_stream_release_identifier \-
nvme_directive_send_stream_release_identifier \- Directive Send Stream release
.SH SYNOPSIS
.B "int" nvme_directive_send_stream_release_identifier
.BI "(int fd " ","

4
doc/man/nvme_directive_send_stream_release_resource.2
View file

@ -1,6 +1,6 @@
.TH "nvme_directive_send_stream_release_resource" 9 "nvme_directive_send_stream_release_resource" "April 2022" "libnvme API manual" LINUX
.TH "nvme_directive_send_stream_release_resource" 9 "nvme_directive_send_stream_release_resource" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_directive_send_stream_release_resource \-
nvme_directive_send_stream_release_resource \- Directive Send Stream release resources
.SH SYNOPSIS
.B "int" nvme_directive_send_stream_release_resource
.BI "(int fd " ","

4
doc/man/nvme_directive_types.2
View file

@ -1,6 +1,6 @@
.TH "libnvme" 9 "enum nvme_directive_types" "April 2022" "API Manual" LINUX
.TH "libnvme" 9 "enum nvme_directive_types" "July 2022" "API Manual" LINUX
.SH NAME
enum nvme_directive_types \-
enum nvme_directive_types \- Directives Supported or Enabled
.SH SYNOPSIS
enum nvme_directive_types {
.br

2
doc/man/nvme_disconnect_ctrl.2
View file

@ -1,4 +1,4 @@
.TH "nvme_disconnect_ctrl" 9 "nvme_disconnect_ctrl" "April 2022" "libnvme API manual" LINUX
.TH "nvme_disconnect_ctrl" 9 "nvme_disconnect_ctrl" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_disconnect_ctrl \- Disconnect a controller
.SH SYNOPSIS

2
doc/man/nvme_dsm.2
View file

@ -1,4 +1,4 @@
.TH "nvme_dsm" 9 "nvme_dsm" "April 2022" "libnvme API manual" LINUX
.TH "nvme_dsm" 9 "nvme_dsm" "July 2022" "libnvme API manual" LINUX
.SH NAME
nvme_dsm \- Send an nvme data set management command
.SH SYNOPSIS

Some files were not shown because too many files have changed in this diff Show more