diff options
Diffstat (limited to 'doc/man')
683 files changed, 2414 insertions, 2737 deletions
diff --git a/doc/man/nvme_admin_opcode.2 b/doc/man/nvme_admin_opcode.2 index a762b8a..a3dcd5f 100644 --- a/doc/man/nvme_admin_opcode.2 +++ b/doc/man/nvme_admin_opcode.2 @@ -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 diff --git a/doc/man/nvme_admin_passthru.2 b/doc/man/nvme_admin_passthru.2 index df4dbf4..b4b2c4a 100644 --- a/doc/man/nvme_admin_passthru.2 +++ b/doc/man/nvme_admin_passthru.2 @@ -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 diff --git a/doc/man/nvme_ae_info_css_nvm.2 b/doc/man/nvme_ae_info_css_nvm.2 index b583463..53500bd 100644 --- a/doc/man/nvme_ae_info_css_nvm.2 +++ b/doc/man/nvme_ae_info_css_nvm.2 @@ -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 diff --git a/doc/man/nvme_ae_info_error.2 b/doc/man/nvme_ae_info_error.2 index 103b6a2..8a9bfa1 100644 --- a/doc/man/nvme_ae_info_error.2 +++ b/doc/man/nvme_ae_info_error.2 @@ -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 diff --git a/doc/man/nvme_ae_info_notice.2 b/doc/man/nvme_ae_info_notice.2 index 9c5ceb2..ceee2d2 100644 --- a/doc/man/nvme_ae_info_notice.2 +++ b/doc/man/nvme_ae_info_notice.2 @@ -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 diff --git a/doc/man/nvme_ae_info_smart.2 b/doc/man/nvme_ae_info_smart.2 index 1a6cd98..89b2276 100644 --- a/doc/man/nvme_ae_info_smart.2 +++ b/doc/man/nvme_ae_info_smart.2 @@ -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 diff --git a/doc/man/nvme_ae_type.2 b/doc/man/nvme_ae_type.2 index 514ea84..e08acd4 100644 --- a/doc/man/nvme_ae_type.2 +++ b/doc/man/nvme_ae_type.2 @@ -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 diff --git a/doc/man/nvme_aggregate_endurance_group_event.2 b/doc/man/nvme_aggregate_endurance_group_event.2 index c7656cd..3d84056 100644 --- a/doc/man/nvme_aggregate_endurance_group_event.2 +++ b/doc/man/nvme_aggregate_endurance_group_event.2 @@ -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 diff --git a/doc/man/nvme_aggregate_predictable_lat_event.2 b/doc/man/nvme_aggregate_predictable_lat_event.2 index 26937e2..74a472f 100644 --- a/doc/man/nvme_aggregate_predictable_lat_event.2 +++ b/doc/man/nvme_aggregate_predictable_lat_event.2 @@ -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 diff --git a/doc/man/nvme_ana_group_desc.2 b/doc/man/nvme_ana_group_desc.2 index 5b8ceb9..08bd476 100644 --- a/doc/man/nvme_ana_group_desc.2 +++ b/doc/man/nvme_ana_group_desc.2 @@ -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 diff --git a/doc/man/nvme_ana_log.2 b/doc/man/nvme_ana_log.2 index 51b4bd8..eb153ec 100644 --- a/doc/man/nvme_ana_log.2 +++ b/doc/man/nvme_ana_log.2 @@ -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 diff --git a/doc/man/nvme_ana_state.2 b/doc/man/nvme_ana_state.2 index 83d50b6..31537da 100644 --- a/doc/man/nvme_ana_state.2 +++ b/doc/man/nvme_ana_state.2 @@ -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 diff --git a/doc/man/nvme_apst_entry.2 b/doc/man/nvme_apst_entry.2 index fb52310..0094bc9 100644 --- a/doc/man/nvme_apst_entry.2 +++ b/doc/man/nvme_apst_entry.2 @@ -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 diff --git a/doc/man/nvme_boot_partition.2 b/doc/man/nvme_boot_partition.2 index 3403da5..748aaca 100644 --- a/doc/man/nvme_boot_partition.2 +++ b/doc/man/nvme_boot_partition.2 @@ -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 diff --git a/doc/man/nvme_cap_config_desc.2 b/doc/man/nvme_cap_config_desc.2 deleted file mode 100644 index e69de29..0000000 --- a/doc/man/nvme_cap_config_desc.2 +++ /dev/null diff --git a/doc/man/nvme_capacity_config_desc.2 b/doc/man/nvme_capacity_config_desc.2 new file mode 100644 index 0000000..5dfce24 --- /dev/null +++ b/doc/man/nvme_capacity_config_desc.2 @@ -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 diff --git a/doc/man/nvme_capacity_mgmt.2 b/doc/man/nvme_capacity_mgmt.2 index 4ebf6a2..31e6b7d 100644 --- a/doc/man/nvme_capacity_mgmt.2 +++ b/doc/man/nvme_capacity_mgmt.2 @@ -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 " ");" diff --git a/doc/man/nvme_capacity_mgmt_args.2 b/doc/man/nvme_capacity_mgmt_args.2 deleted file mode 100644 index b3c42e7..0000000 --- a/doc/man/nvme_capacity_mgmt_args.2 +++ /dev/null @@ -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 diff --git a/doc/man/nvme_change_ns_event.2 b/doc/man/nvme_change_ns_event.2 index e7d329c..6d71571 100644 --- a/doc/man/nvme_change_ns_event.2 +++ b/doc/man/nvme_change_ns_event.2 @@ -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 diff --git a/doc/man/nvme_channel_config_desc.2 b/doc/man/nvme_channel_config_desc.2 index 844f858..b1a3702 100644 --- a/doc/man/nvme_channel_config_desc.2 +++ b/doc/man/nvme_channel_config_desc.2 @@ -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 diff --git a/doc/man/nvme_cmb_size.2 b/doc/man/nvme_cmb_size.2 index 395347d..5185d22 100644 --- a/doc/man/nvme_cmb_size.2 +++ b/doc/man/nvme_cmb_size.2 @@ -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 diff --git a/doc/man/nvme_cmd_effects.2 b/doc/man/nvme_cmd_effects.2 index f0cf27b..a7ee5a5 100644 --- a/doc/man/nvme_cmd_effects.2 +++ b/doc/man/nvme_cmd_effects.2 @@ -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 diff --git a/doc/man/nvme_cmd_effects_log.2 b/doc/man/nvme_cmd_effects_log.2 index 7458732..10f16a3 100644 --- a/doc/man/nvme_cmd_effects_log.2 +++ b/doc/man/nvme_cmd_effects_log.2 @@ -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 diff --git a/doc/man/nvme_cmd_format_mset.2 b/doc/man/nvme_cmd_format_mset.2 index dba60cd..3ee16a2 100644 --- a/doc/man/nvme_cmd_format_mset.2 +++ b/doc/man/nvme_cmd_format_mset.2 @@ -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 diff --git a/doc/man/nvme_cmd_format_pi.2 b/doc/man/nvme_cmd_format_pi.2 index 4388656..c8f6c6f 100644 --- a/doc/man/nvme_cmd_format_pi.2 +++ b/doc/man/nvme_cmd_format_pi.2 @@ -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 diff --git a/doc/man/nvme_cmd_format_pil.2 b/doc/man/nvme_cmd_format_pil.2 index a0b3269..5fc9ee4 100644 --- a/doc/man/nvme_cmd_format_pil.2 +++ b/doc/man/nvme_cmd_format_pil.2 @@ -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 diff --git a/doc/man/nvme_cmd_format_ses.2 b/doc/man/nvme_cmd_format_ses.2 index d2b6ed5..3659de6 100644 --- a/doc/man/nvme_cmd_format_ses.2 +++ b/doc/man/nvme_cmd_format_ses.2 @@ -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 diff --git a/doc/man/nvme_cmd_get_log_lid.2 b/doc/man/nvme_cmd_get_log_lid.2 index f2023ad..5b95da3 100644 --- a/doc/man/nvme_cmd_get_log_lid.2 +++ b/doc/man/nvme_cmd_get_log_lid.2 @@ -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 diff --git a/doc/man/nvme_cmd_get_log_telemetry_host_lsp.2 b/doc/man/nvme_cmd_get_log_telemetry_host_lsp.2 index 062093a..4ec47b5 100644 --- a/doc/man/nvme_cmd_get_log_telemetry_host_lsp.2 +++ b/doc/man/nvme_cmd_get_log_telemetry_host_lsp.2 @@ -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 diff --git a/doc/man/nvme_compare.2 b/doc/man/nvme_compare.2 index 5a3214b..a7f3f9b 100644 --- a/doc/man/nvme_compare.2 +++ b/doc/man/nvme_compare.2 @@ -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 diff --git a/doc/man/nvme_connect_err.2 b/doc/man/nvme_connect_err.2 index 821fa74..ffffa77 100644 --- a/doc/man/nvme_connect_err.2 +++ b/doc/man/nvme_connect_err.2 @@ -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 diff --git a/doc/man/nvme_constants.2 b/doc/man/nvme_constants.2 index ab07e99..db65412 100644 --- a/doc/man/nvme_constants.2 +++ b/doc/man/nvme_constants.2 @@ -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 diff --git a/doc/man/nvme_copy.2 b/doc/man/nvme_copy.2 index c8cdf33..9651d1e 100644 --- a/doc/man/nvme_copy.2 +++ b/doc/man/nvme_copy.2 @@ -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 " ");" diff --git a/doc/man/nvme_copy_args.2 b/doc/man/nvme_copy_args.2 deleted file mode 100644 index 5cc2fe1..0000000 --- a/doc/man/nvme_copy_args.2 +++ /dev/null @@ -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 diff --git a/doc/man/nvme_copy_range.2 b/doc/man/nvme_copy_range.2 index 590d4f1..564acf4 100644 --- a/doc/man/nvme_copy_range.2 +++ b/doc/man/nvme_copy_range.2 @@ -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 diff --git a/doc/man/nvme_create_ctrl.2 b/doc/man/nvme_create_ctrl.2 index 8cab856..8207345 100644 --- a/doc/man/nvme_create_ctrl.2 +++ b/doc/man/nvme_create_ctrl.2 @@ -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 diff --git a/doc/man/nvme_create_root.2 b/doc/man/nvme_create_root.2 index fc8cdab..5ee7cf2 100644 --- a/doc/man/nvme_create_root.2 +++ b/doc/man/nvme_create_root.2 @@ -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 diff --git a/doc/man/nvme_csi.2 b/doc/man/nvme_csi.2 index 0a8523c..0041e84 100644 --- a/doc/man/nvme_csi.2 +++ b/doc/man/nvme_csi.2 @@ -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 diff --git a/doc/man/nvme_ctrl_first_ns.2 b/doc/man/nvme_ctrl_first_ns.2 index a8ef754..997381b 100644 --- a/doc/man/nvme_ctrl_first_ns.2 +++ b/doc/man/nvme_ctrl_first_ns.2 @@ -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 diff --git a/doc/man/nvme_ctrl_first_path.2 b/doc/man/nvme_ctrl_first_path.2 index 606feef..b018970 100644 --- a/doc/man/nvme_ctrl_first_path.2 +++ b/doc/man/nvme_ctrl_first_path.2 @@ -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 diff --git a/doc/man/nvme_ctrl_for_each_ns.2 b/doc/man/nvme_ctrl_for_each_ns.2 index 97b08b1..7ccc730 100644 --- a/doc/man/nvme_ctrl_for_each_ns.2 +++ b/doc/man/nvme_ctrl_for_each_ns.2 @@ -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 diff --git a/doc/man/nvme_ctrl_for_each_ns_safe.2 b/doc/man/nvme_ctrl_for_each_ns_safe.2 index 844a7c7..2fb7bb9 100644 --- a/doc/man/nvme_ctrl_for_each_ns_safe.2 +++ b/doc/man/nvme_ctrl_for_each_ns_safe.2 @@ -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 diff --git a/doc/man/nvme_ctrl_for_each_path.2 b/doc/man/nvme_ctrl_for_each_path.2 index ad85b94..a4fd3e9 100644 --- a/doc/man/nvme_ctrl_for_each_path.2 +++ b/doc/man/nvme_ctrl_for_each_path.2 @@ -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 diff --git a/doc/man/nvme_ctrl_for_each_path_safe.2 b/doc/man/nvme_ctrl_for_each_path_safe.2 index b341119..a1c0685 100644 --- a/doc/man/nvme_ctrl_for_each_path_safe.2 +++ b/doc/man/nvme_ctrl_for_each_path_safe.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_address.2 b/doc/man/nvme_ctrl_get_address.2 index 559a5de..dae7fe7 100644 --- a/doc/man/nvme_ctrl_get_address.2 +++ b/doc/man/nvme_ctrl_get_address.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_config.2 b/doc/man/nvme_ctrl_get_config.2 index 130de7e..0f767b7 100644 --- a/doc/man/nvme_ctrl_get_config.2 +++ b/doc/man/nvme_ctrl_get_config.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_dhchap_key.2 b/doc/man/nvme_ctrl_get_dhchap_key.2 index e9191da..1ba62f3 100644 --- a/doc/man/nvme_ctrl_get_dhchap_key.2 +++ b/doc/man/nvme_ctrl_get_dhchap_key.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_fd.2 b/doc/man/nvme_ctrl_get_fd.2 index 699c823..c28d18d 100644 --- a/doc/man/nvme_ctrl_get_fd.2 +++ b/doc/man/nvme_ctrl_get_fd.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_firmware.2 b/doc/man/nvme_ctrl_get_firmware.2 index 9072a2a..a784fe4 100644 --- a/doc/man/nvme_ctrl_get_firmware.2 +++ b/doc/man/nvme_ctrl_get_firmware.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_host_iface.2 b/doc/man/nvme_ctrl_get_host_iface.2 index 792795b..409399e 100644 --- a/doc/man/nvme_ctrl_get_host_iface.2 +++ b/doc/man/nvme_ctrl_get_host_iface.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_host_traddr.2 b/doc/man/nvme_ctrl_get_host_traddr.2 index 7972169..63aa8a9 100644 --- a/doc/man/nvme_ctrl_get_host_traddr.2 +++ b/doc/man/nvme_ctrl_get_host_traddr.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_model.2 b/doc/man/nvme_ctrl_get_model.2 index 41b5b50..1d938de 100644 --- a/doc/man/nvme_ctrl_get_model.2 +++ b/doc/man/nvme_ctrl_get_model.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_name.2 b/doc/man/nvme_ctrl_get_name.2 index 022766a..850a860 100644 --- a/doc/man/nvme_ctrl_get_name.2 +++ b/doc/man/nvme_ctrl_get_name.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_numa_node.2 b/doc/man/nvme_ctrl_get_numa_node.2 index 06e199f..6954a35 100644 --- a/doc/man/nvme_ctrl_get_numa_node.2 +++ b/doc/man/nvme_ctrl_get_numa_node.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_queue_count.2 b/doc/man/nvme_ctrl_get_queue_count.2 index 0645e4a..193af2a 100644 --- a/doc/man/nvme_ctrl_get_queue_count.2 +++ b/doc/man/nvme_ctrl_get_queue_count.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_serial.2 b/doc/man/nvme_ctrl_get_serial.2 index 646c43c..bb046a3 100644 --- a/doc/man/nvme_ctrl_get_serial.2 +++ b/doc/man/nvme_ctrl_get_serial.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_sqsize.2 b/doc/man/nvme_ctrl_get_sqsize.2 index 2ee323a..9542bc9 100644 --- a/doc/man/nvme_ctrl_get_sqsize.2 +++ b/doc/man/nvme_ctrl_get_sqsize.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_state.2 b/doc/man/nvme_ctrl_get_state.2 index 8114541..dbbd478 100644 --- a/doc/man/nvme_ctrl_get_state.2 +++ b/doc/man/nvme_ctrl_get_state.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_subsysnqn.2 b/doc/man/nvme_ctrl_get_subsysnqn.2 index 13ae3f2..3698346 100644 --- a/doc/man/nvme_ctrl_get_subsysnqn.2 +++ b/doc/man/nvme_ctrl_get_subsysnqn.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_subsystem.2 b/doc/man/nvme_ctrl_get_subsystem.2 index d522928..960e1fb 100644 --- a/doc/man/nvme_ctrl_get_subsystem.2 +++ b/doc/man/nvme_ctrl_get_subsystem.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_sysfs_dir.2 b/doc/man/nvme_ctrl_get_sysfs_dir.2 index fb7973e..224618c 100644 --- a/doc/man/nvme_ctrl_get_sysfs_dir.2 +++ b/doc/man/nvme_ctrl_get_sysfs_dir.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_traddr.2 b/doc/man/nvme_ctrl_get_traddr.2 index bf6963e..706cedc 100644 --- a/doc/man/nvme_ctrl_get_traddr.2 +++ b/doc/man/nvme_ctrl_get_traddr.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_transport.2 b/doc/man/nvme_ctrl_get_transport.2 index e7acdfa..588fa1b 100644 --- a/doc/man/nvme_ctrl_get_transport.2 +++ b/doc/man/nvme_ctrl_get_transport.2 @@ -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 diff --git a/doc/man/nvme_ctrl_get_trsvcid.2 b/doc/man/nvme_ctrl_get_trsvcid.2 index b889a6c..0380a27 100644 --- a/doc/man/nvme_ctrl_get_trsvcid.2 +++ b/doc/man/nvme_ctrl_get_trsvcid.2 @@ -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 diff --git a/doc/man/nvme_ctrl_identify.2 b/doc/man/nvme_ctrl_identify.2 index 1bd849a..dfae018 100644 --- a/doc/man/nvme_ctrl_identify.2 +++ b/doc/man/nvme_ctrl_identify.2 @@ -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 diff --git a/doc/man/nvme_ctrl_is_discovered.2 b/doc/man/nvme_ctrl_is_discovered.2 index 70d0ebe..a78f8d5 100644 --- a/doc/man/nvme_ctrl_is_discovered.2 +++ b/doc/man/nvme_ctrl_is_discovered.2 @@ -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 diff --git a/doc/man/nvme_ctrl_is_discovery_ctrl.2 b/doc/man/nvme_ctrl_is_discovery_ctrl.2 index 2255323..54e25e4 100644 --- a/doc/man/nvme_ctrl_is_discovery_ctrl.2 +++ b/doc/man/nvme_ctrl_is_discovery_ctrl.2 @@ -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 diff --git a/doc/man/nvme_ctrl_is_persistent.2 b/doc/man/nvme_ctrl_is_persistent.2 index 9af269c..09e6934 100644 --- a/doc/man/nvme_ctrl_is_persistent.2 +++ b/doc/man/nvme_ctrl_is_persistent.2 @@ -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 diff --git a/doc/man/nvme_ctrl_list.2 b/doc/man/nvme_ctrl_list.2 index 85e11af..5d6b248 100644 --- a/doc/man/nvme_ctrl_list.2 +++ b/doc/man/nvme_ctrl_list.2 @@ -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 diff --git a/doc/man/nvme_ctrl_metadata_type.2 b/doc/man/nvme_ctrl_metadata_type.2 index eed88d8..76449bf 100644 --- a/doc/man/nvme_ctrl_metadata_type.2 +++ b/doc/man/nvme_ctrl_metadata_type.2 @@ -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 diff --git a/doc/man/nvme_ctrl_next_ns.2 b/doc/man/nvme_ctrl_next_ns.2 index 194dcfc..031f449 100644 --- a/doc/man/nvme_ctrl_next_ns.2 +++ b/doc/man/nvme_ctrl_next_ns.2 @@ -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 diff --git a/doc/man/nvme_ctrl_next_path.2 b/doc/man/nvme_ctrl_next_path.2 index b494a73..84c5be2 100644 --- a/doc/man/nvme_ctrl_next_path.2 +++ b/doc/man/nvme_ctrl_next_path.2 @@ -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 diff --git a/doc/man/nvme_ctrl_reset.2 b/doc/man/nvme_ctrl_reset.2 index 4912171..0bb4072 100644 --- a/doc/man/nvme_ctrl_reset.2 +++ b/doc/man/nvme_ctrl_reset.2 @@ -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 diff --git a/doc/man/nvme_ctrl_set_dhchap_key.2 b/doc/man/nvme_ctrl_set_dhchap_key.2 index 0e02292..577beac 100644 --- a/doc/man/nvme_ctrl_set_dhchap_key.2 +++ b/doc/man/nvme_ctrl_set_dhchap_key.2 @@ -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 diff --git a/doc/man/nvme_ctrl_set_discovered.2 b/doc/man/nvme_ctrl_set_discovered.2 index f895e51..3e68dd9 100644 --- a/doc/man/nvme_ctrl_set_discovered.2 +++ b/doc/man/nvme_ctrl_set_discovered.2 @@ -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 diff --git a/doc/man/nvme_ctrl_set_discovery_ctrl.2 b/doc/man/nvme_ctrl_set_discovery_ctrl.2 index 824d201..9352161 100644 --- a/doc/man/nvme_ctrl_set_discovery_ctrl.2 +++ b/doc/man/nvme_ctrl_set_discovery_ctrl.2 @@ -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 diff --git a/doc/man/nvme_ctrl_set_persistent.2 b/doc/man/nvme_ctrl_set_persistent.2 index 6d70b36..9b6e3ae 100644 --- a/doc/man/nvme_ctrl_set_persistent.2 +++ b/doc/man/nvme_ctrl_set_persistent.2 @@ -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 diff --git a/doc/man/nvme_ctrls_filter.2 b/doc/man/nvme_ctrls_filter.2 index 59aeaaf..0b1adc2 100644 --- a/doc/man/nvme_ctrls_filter.2 +++ b/doc/man/nvme_ctrls_filter.2 @@ -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 diff --git a/doc/man/nvme_default_host.2 b/doc/man/nvme_default_host.2 index 73ebb07..7d6ce0f 100644 --- a/doc/man/nvme_default_host.2 +++ b/doc/man/nvme_default_host.2 @@ -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 diff --git a/doc/man/nvme_dev_self_test.2 b/doc/man/nvme_dev_self_test.2 index b0d6d9e..b4e74e2 100644 --- a/doc/man/nvme_dev_self_test.2 +++ b/doc/man/nvme_dev_self_test.2 @@ -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 diff --git a/doc/man/nvme_dev_self_test_args.2 b/doc/man/nvme_dev_self_test_args.2 deleted file mode 100644 index a8cfb35..0000000 --- a/doc/man/nvme_dev_self_test_args.2 +++ /dev/null @@ -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 diff --git a/doc/man/nvme_dim_args.2 b/doc/man/nvme_dim_args.2 deleted file mode 100644 index 8a674eb..0000000 --- a/doc/man/nvme_dim_args.2 +++ /dev/null @@ -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) diff --git a/doc/man/nvme_directive_dtype.2 b/doc/man/nvme_directive_dtype.2 index e50bc32..99b3d40 100644 --- a/doc/man/nvme_directive_dtype.2 +++ b/doc/man/nvme_directive_dtype.2 @@ -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 diff --git a/doc/man/nvme_directive_receive_doper.2 b/doc/man/nvme_directive_receive_doper.2 index 0095be2..e084ac8 100644 --- a/doc/man/nvme_directive_receive_doper.2 +++ b/doc/man/nvme_directive_receive_doper.2 @@ -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 diff --git a/doc/man/nvme_directive_recv.2 b/doc/man/nvme_directive_recv.2 index ae3802e..577e428 100644 --- a/doc/man/nvme_directive_recv.2 +++ b/doc/man/nvme_directive_recv.2 @@ -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 diff --git a/doc/man/nvme_directive_recv_args.2 b/doc/man/nvme_directive_recv_args.2 deleted file mode 100644 index 83345ef..0000000 --- a/doc/man/nvme_directive_recv_args.2 +++ /dev/null @@ -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 diff --git a/doc/man/nvme_directive_recv_identify_parameters.2 b/doc/man/nvme_directive_recv_identify_parameters.2 index d067edc..236cbb8 100644 --- a/doc/man/nvme_directive_recv_identify_parameters.2 +++ b/doc/man/nvme_directive_recv_identify_parameters.2 @@ -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 " "," diff --git a/doc/man/nvme_directive_recv_stream_allocate.2 b/doc/man/nvme_directive_recv_stream_allocate.2 index 24057ec..9e1ed51 100644 --- a/doc/man/nvme_directive_recv_stream_allocate.2 +++ b/doc/man/nvme_directive_recv_stream_allocate.2 @@ -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 " "," diff --git a/doc/man/nvme_directive_recv_stream_parameters.2 b/doc/man/nvme_directive_recv_stream_parameters.2 index fdcdec6..7cc6cbd 100644 --- a/doc/man/nvme_directive_recv_stream_parameters.2 +++ b/doc/man/nvme_directive_recv_stream_parameters.2 @@ -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 " "," diff --git a/doc/man/nvme_directive_recv_stream_status.2 b/doc/man/nvme_directive_recv_stream_status.2 index d3b20f2..d3d8851 100644 --- a/doc/man/nvme_directive_recv_stream_status.2 +++ b/doc/man/nvme_directive_recv_stream_status.2 @@ -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 diff --git a/doc/man/nvme_directive_send.2 b/doc/man/nvme_directive_send.2 index af9d0fc..3e412d2 100644 --- a/doc/man/nvme_directive_send.2 +++ b/doc/man/nvme_directive_send.2 @@ -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 diff --git a/doc/man/nvme_directive_send_args.2 b/doc/man/nvme_directive_send_args.2 deleted file mode 100644 index d8de887..0000000 --- a/doc/man/nvme_directive_send_args.2 +++ /dev/null @@ -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 diff --git a/doc/man/nvme_directive_send_doper.2 b/doc/man/nvme_directive_send_doper.2 index 4d3ece1..13bd4af 100644 --- a/doc/man/nvme_directive_send_doper.2 +++ b/doc/man/nvme_directive_send_doper.2 @@ -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 diff --git a/doc/man/nvme_directive_send_id_endir.2 b/doc/man/nvme_directive_send_id_endir.2 index c3b31ee..ff6867f 100644 --- a/doc/man/nvme_directive_send_id_endir.2 +++ b/doc/man/nvme_directive_send_id_endir.2 @@ -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 " "," diff --git a/doc/man/nvme_directive_send_identify_endir.2 b/doc/man/nvme_directive_send_identify_endir.2 index f6cb007..32eb52e 100644 --- a/doc/man/nvme_directive_send_identify_endir.2 +++ b/doc/man/nvme_directive_send_identify_endir.2 @@ -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 diff --git a/doc/man/nvme_directive_send_stream_release_identifier.2 b/doc/man/nvme_directive_send_stream_release_identifier.2 index 9768cd6..c3274fd 100644 --- a/doc/man/nvme_directive_send_stream_release_identifier.2 +++ b/doc/man/nvme_directive_send_stream_release_identifier.2 @@ -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 " "," diff --git a/doc/man/nvme_directive_send_stream_release_resource.2 b/doc/man/nvme_directive_send_stream_release_resource.2 index 32ebab4..3fcc5a6 100644 --- a/doc/man/nvme_directive_send_stream_release_resource.2 +++ b/doc/man/nvme_directive_send_stream_release_resource.2 @@ -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 " "," diff --git a/doc/man/nvme_directive_types.2 b/doc/man/nvme_directive_types.2 index aa2e48c..9662c86 100644 --- a/doc/man/nvme_directive_types.2 +++ b/doc/man/nvme_directive_types.2 @@ -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 diff --git a/doc/man/nvme_disconnect_ctrl.2 b/doc/man/nvme_disconnect_ctrl.2 index 35a8a0a..e13355d 100644 --- a/doc/man/nvme_disconnect_ctrl.2 +++ b/doc/man/nvme_disconnect_ctrl.2 @@ -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 diff --git a/doc/man/nvme_dsm.2 b/doc/man/nvme_dsm.2 index 4803104..d22ea68 100644 --- a/doc/man/nvme_dsm.2 +++ b/doc/man/nvme_dsm.2 @@ -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 diff --git a/doc/man/nvme_dsm_args.2 b/doc/man/nvme_dsm_args.2 deleted file mode 100644 index bb4f645..0000000 --- a/doc/man/nvme_dsm_args.2 +++ /dev/null @@ -1,43 +0,0 @@ -.TH "libnvme" 9 "struct nvme_dsm_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_dsm_args \- Arguments for the NVMe Dataset Management command -.SH SYNOPSIS -struct nvme_dsm_args { -.br -.BI " __u32 *result;" -.br -.BI " struct nvme_dsm_range *dsm;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " __u32 nsid;" -.br -.BI " __u32 attrs;" -.br -.BI " __u16 nr_ranges;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "dsm" 12 -The data set management attributes -.IP "args_size" 12 -Size of \fIstruct nvme_dsm_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace identifier -.IP "attrs" 12 -DSM attributes, see \fIenum nvme_dsm_attributes\fP -.IP "nr_ranges" 12 -Number of block ranges in the data set management attributes diff --git a/doc/man/nvme_dsm_attributes.2 b/doc/man/nvme_dsm_attributes.2 index 1814d87..075fcfc 100644 --- a/doc/man/nvme_dsm_attributes.2 +++ b/doc/man/nvme_dsm_attributes.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_dsm_attributes" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_dsm_attributes" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_dsm_attributes \- +enum nvme_dsm_attributes \- Dataset Management attributes .SH SYNOPSIS enum nvme_dsm_attributes { .br @@ -17,8 +17,8 @@ enum nvme_dsm_attributes { }; .SH Constants .IP "NVME_DSMGMT_IDR" 12 -Attribute – Integral Dataset for Read +Attribute -Integral Dataset for Read .IP "NVME_DSMGMT_IDW" 12 -Attribute – Integral Dataset for Write +Attribute - Integral Dataset for Write .IP "NVME_DSMGMT_AD" 12 -Attribute – Deallocate +Attribute - Deallocate diff --git a/doc/man/nvme_dsm_range.2 b/doc/man/nvme_dsm_range.2 index 1edd263..a2c04b6 100644 --- a/doc/man/nvme_dsm_range.2 +++ b/doc/man/nvme_dsm_range.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_dsm_range" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_dsm_range" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_dsm_range \- +struct nvme_dsm_range \- Dataset Management - Range Definition .SH SYNOPSIS struct nvme_dsm_range { .br diff --git a/doc/man/nvme_dst_stc.2 b/doc/man/nvme_dst_stc.2 index 991a171..3825044 100644 --- a/doc/man/nvme_dst_stc.2 +++ b/doc/man/nvme_dst_stc.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_dst_stc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_dst_stc" "July 2022" "API Manual" LINUX .SH NAME enum nvme_dst_stc \- Action taken by the Device Self-test command .SH SYNOPSIS diff --git a/doc/man/nvme_dump_config.2 b/doc/man/nvme_dump_config.2 index d3e9f1f..49bc3ea 100644 --- a/doc/man/nvme_dump_config.2 +++ b/doc/man/nvme_dump_config.2 @@ -1,4 +1,4 @@ -.TH "nvme_dump_config" 9 "nvme_dump_config" "April 2022" "libnvme API manual" LINUX +.TH "nvme_dump_config" 9 "nvme_dump_config" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_dump_config \- Print the JSON configuration .SH SYNOPSIS diff --git a/doc/man/nvme_dump_tree.2 b/doc/man/nvme_dump_tree.2 index 505f94c..e97da3b 100644 --- a/doc/man/nvme_dump_tree.2 +++ b/doc/man/nvme_dump_tree.2 @@ -1,4 +1,4 @@ -.TH "nvme_dump_tree" 9 "nvme_dump_tree" "April 2022" "libnvme API manual" LINUX +.TH "nvme_dump_tree" 9 "nvme_dump_tree" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_dump_tree \- Dump internal object tree .SH SYNOPSIS diff --git a/doc/man/nvme_eg_critical_warning_flags.2 b/doc/man/nvme_eg_critical_warning_flags.2 index ec2a3ff..fad3a9d 100644 --- a/doc/man/nvme_eg_critical_warning_flags.2 +++ b/doc/man/nvme_eg_critical_warning_flags.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_eg_critical_warning_flags" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_eg_critical_warning_flags" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_eg_critical_warning_flags \- +enum nvme_eg_critical_warning_flags \- Endurance Group Information Log - Critical Warning .SH SYNOPSIS enum nvme_eg_critical_warning_flags { .br @@ -17,5 +17,10 @@ enum nvme_eg_critical_warning_flags { }; .SH Constants .IP "NVME_EG_CRITICAL_WARNING_SPARE" 12 +Available spare capacity of the Endurance Group +has fallen below the threshold .IP "NVME_EG_CRITICAL_WARNING_DEGRADED" 12 +Endurance Group reliability has been degraded .IP "NVME_EG_CRITICAL_WARNING_READ_ONLY" 12 +Endurance Group have been placed in read only +mode diff --git a/doc/man/nvme_eg_event_aggregate_log.2 b/doc/man/nvme_eg_event_aggregate_log.2 index 0546d53..3d9e8f1 100644 --- a/doc/man/nvme_eg_event_aggregate_log.2 +++ b/doc/man/nvme_eg_event_aggregate_log.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_eg_event_aggregate_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_eg_event_aggregate_log" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_eg_event_aggregate_log \- +struct nvme_eg_event_aggregate_log \- Endurance Group Event Aggregate .SH SYNOPSIS struct nvme_eg_event_aggregate_log { .br diff --git a/doc/man/nvme_end_grp_chan_desc.2 b/doc/man/nvme_end_grp_chan_desc.2 index a7a810f..e8817ef 100644 --- a/doc/man/nvme_end_grp_chan_desc.2 +++ b/doc/man/nvme_end_grp_chan_desc.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_end_grp_chan_desc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_end_grp_chan_desc" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_end_grp_chan_desc \- +struct nvme_end_grp_chan_desc \- Endurance Group Channel Configuration Descriptor .SH SYNOPSIS struct nvme_end_grp_chan_desc { .br @@ -15,6 +15,6 @@ struct nvme_end_grp_chan_desc { .SH Members .IP "egchans" 12 Number of Channels -.SH "Description" -Endurance group Channel Configuration Descriptor -Structure Definitions +.IP "chan_config_desc" 12 +Channel config descriptors. +See \fIstruct\fP nvme_channel_config_desc diff --git a/doc/man/nvme_end_grp_config_desc.2 b/doc/man/nvme_end_grp_config_desc.2 index b418522..2bc146d 100644 --- a/doc/man/nvme_end_grp_config_desc.2 +++ b/doc/man/nvme_end_grp_config_desc.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_end_grp_config_desc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_end_grp_config_desc" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_end_grp_config_desc \- +struct nvme_end_grp_config_desc \- Endurance Group Configuration Descriptor .SH SYNOPSIS struct nvme_end_grp_config_desc { .br @@ -31,16 +31,17 @@ struct nvme_end_grp_config_desc { Endurance Group Identifier .IP "cap_adj_factor" 12 Capacity Adjustment Factor +.IP "rsvd4" 12 +Reserved .IP "tegcap" 12 Total Endurance Group Capacity .IP "segcap" 12 Spare Endurance Group Capacity .IP "end_est" 12 Endurance Estimate +.IP "rsvd64" 12 +Reserved .IP "egsets" 12 Number of NVM Sets .IP "nvmsetid" 12 NVM Set Identifier -.SH "Description" -Endurance Group Configuration Descriptor -Structure Definitions diff --git a/doc/man/nvme_endurance_group_log.2 b/doc/man/nvme_endurance_group_log.2 index 1ba728f..7155373 100644 --- a/doc/man/nvme_endurance_group_log.2 +++ b/doc/man/nvme_endurance_group_log.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_endurance_group_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_endurance_group_log" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_endurance_group_log \- +struct nvme_endurance_group_log \- Endurance Group Information Log .SH SYNOPSIS struct nvme_endurance_group_log { .br diff --git a/doc/man/nvme_err_pel.2 b/doc/man/nvme_err_pel.2 deleted file mode 100644 index e217cf7..0000000 --- a/doc/man/nvme_err_pel.2 +++ /dev/null @@ -1,16 +0,0 @@ -.TH "libnvme" 9 "enum nvme_err_pel" "April 2022" "API Manual" LINUX -.SH NAME -enum nvme_err_pel \- -.SH SYNOPSIS -enum nvme_err_pel { -.br -.BI " NVME_ERR_PEL_BYTE_MASK" -, -.br -.br -.BI " NVME_ERR_PEL_BIT_MASK" - -}; -.SH Constants -.IP "NVME_ERR_PEL_BYTE_MASK" 12 -.IP "NVME_ERR_PEL_BIT_MASK" 12 diff --git a/doc/man/nvme_errno_to_string.2 b/doc/man/nvme_errno_to_string.2 index 6e8ea1c..867647c 100644 --- a/doc/man/nvme_errno_to_string.2 +++ b/doc/man/nvme_errno_to_string.2 @@ -1,4 +1,4 @@ -.TH "nvme_errno_to_string" 9 "nvme_errno_to_string" "April 2022" "libnvme API manual" LINUX +.TH "nvme_errno_to_string" 9 "nvme_errno_to_string" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_errno_to_string \- Returns string describing nvme connect failures .SH SYNOPSIS diff --git a/doc/man/nvme_error_log_page.2 b/doc/man/nvme_error_log_page.2 index f6a908c..d487fb0 100644 --- a/doc/man/nvme_error_log_page.2 +++ b/doc/man/nvme_error_log_page.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_error_log_page" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_error_log_page" "July 2022" "API Manual" LINUX .SH NAME struct nvme_error_log_page \- Error Information Log Entry (Log Identifier 01h) .SH SYNOPSIS diff --git a/doc/man/nvme_fabrics_config.2 b/doc/man/nvme_fabrics_config.2 index f54377f..b5f868d 100644 --- a/doc/man/nvme_fabrics_config.2 +++ b/doc/man/nvme_fabrics_config.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_fabrics_config" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_fabrics_config" "July 2022" "API Manual" LINUX .SH NAME struct nvme_fabrics_config \- Defines all linux nvme fabrics initiator options .SH SYNOPSIS diff --git a/doc/man/nvme_fctype.2 b/doc/man/nvme_fctype.2 index 560a989..b95a654 100644 --- a/doc/man/nvme_fctype.2 +++ b/doc/man/nvme_fctype.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_fctype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_fctype" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_fctype \- +enum nvme_fctype \- Fabrics Command Types .SH SYNOPSIS enum nvme_fctype { .br diff --git a/doc/man/nvme_feat.2 b/doc/man/nvme_feat.2 index 981cd62..653288a 100644 --- a/doc/man/nvme_feat.2 +++ b/doc/man/nvme_feat.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_feat" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_feat" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_feat \- +enum nvme_feat \- Features Access Shifts/Masks values .SH SYNOPSIS enum nvme_feat { .br diff --git a/doc/man/nvme_feat_auto_pst.2 b/doc/man/nvme_feat_auto_pst.2 index c84f481..7a4eca4 100644 --- a/doc/man/nvme_feat_auto_pst.2 +++ b/doc/man/nvme_feat_auto_pst.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_feat_auto_pst" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_feat_auto_pst" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_feat_auto_pst \- +struct nvme_feat_auto_pst \- Autonomous Power State Transition .SH SYNOPSIS struct nvme_feat_auto_pst { .br diff --git a/doc/man/nvme_feat_host_behavior.2 b/doc/man/nvme_feat_host_behavior.2 index 7f9be77..ea66ad1 100644 --- a/doc/man/nvme_feat_host_behavior.2 +++ b/doc/man/nvme_feat_host_behavior.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_feat_host_behavior" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_feat_host_behavior" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_feat_host_behavior \- +struct nvme_feat_host_behavior \- Host Behavior Support - Data Structure .SH SYNOPSIS struct nvme_feat_host_behavior { .br diff --git a/doc/man/nvme_feat_nswpcfg_state.2 b/doc/man/nvme_feat_nswpcfg_state.2 index c671e63..bd8b00f 100644 --- a/doc/man/nvme_feat_nswpcfg_state.2 +++ b/doc/man/nvme_feat_nswpcfg_state.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_feat_nswpcfg_state" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_feat_nswpcfg_state" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_feat_nswpcfg_state \- +enum nvme_feat_nswpcfg_state \- Write Protection - Write Protection State .SH SYNOPSIS enum nvme_feat_nswpcfg_state { .br diff --git a/doc/man/nvme_feat_plm_window_select.2 b/doc/man/nvme_feat_plm_window_select.2 index a864d98..883c9a1 100644 --- a/doc/man/nvme_feat_plm_window_select.2 +++ b/doc/man/nvme_feat_plm_window_select.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_feat_plm_window_select" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_feat_plm_window_select" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_feat_plm_window_select \- +enum nvme_feat_plm_window_select \- Predictable Latency Per NVM Set Log .SH SYNOPSIS enum nvme_feat_plm_window_select { .br diff --git a/doc/man/nvme_feat_resv_notify_flags.2 b/doc/man/nvme_feat_resv_notify_flags.2 index 53a262b..c7497de 100644 --- a/doc/man/nvme_feat_resv_notify_flags.2 +++ b/doc/man/nvme_feat_resv_notify_flags.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_feat_resv_notify_flags" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_feat_resv_notify_flags" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_feat_resv_notify_flags \- +enum nvme_feat_resv_notify_flags \- Reservation Notification Configuration .SH SYNOPSIS enum nvme_feat_resv_notify_flags { .br diff --git a/doc/man/nvme_feat_tmpthresh_thsel.2 b/doc/man/nvme_feat_tmpthresh_thsel.2 index 1c91429..9197093 100644 --- a/doc/man/nvme_feat_tmpthresh_thsel.2 +++ b/doc/man/nvme_feat_tmpthresh_thsel.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_feat_tmpthresh_thsel" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_feat_tmpthresh_thsel" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_feat_tmpthresh_thsel \- +enum nvme_feat_tmpthresh_thsel \- Temperature Threshold - Threshold Type Select .SH SYNOPSIS enum nvme_feat_tmpthresh_thsel { .br diff --git a/doc/man/nvme_features_async_event_config_flags.2 b/doc/man/nvme_features_async_event_config_flags.2 index eaa5062..e9fd0be 100644 --- a/doc/man/nvme_features_async_event_config_flags.2 +++ b/doc/man/nvme_features_async_event_config_flags.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_features_async_event_config_flags" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_features_async_event_config_flags" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_features_async_event_config_flags \- +enum nvme_features_async_event_config_flags \- Asynchronous Event Configuration configuration flags .SH SYNOPSIS enum nvme_features_async_event_config_flags { .br diff --git a/doc/man/nvme_features_id.2 b/doc/man/nvme_features_id.2 index a908964..3f3aca7 100644 --- a/doc/man/nvme_features_id.2 +++ b/doc/man/nvme_features_id.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_features_id" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_features_id" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_features_id \- +enum nvme_features_id \- Features - Feature Identifiers .SH SYNOPSIS enum nvme_features_id { .br diff --git a/doc/man/nvme_fid_supported_effects.2 b/doc/man/nvme_fid_supported_effects.2 index 353ed27..b1b390d 100644 --- a/doc/man/nvme_fid_supported_effects.2 +++ b/doc/man/nvme_fid_supported_effects.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_fid_supported_effects" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_fid_supported_effects" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_fid_supported_effects \- +enum nvme_fid_supported_effects \- FID Supported and Effects Data Structure definitions .SH SYNOPSIS enum nvme_fid_supported_effects { .br @@ -61,18 +61,30 @@ enum nvme_fid_supported_effects { }; .SH Constants .IP "NVME_FID_SUPPORTED_EFFECTS_FSUPP" 12 +FID Supported .IP "NVME_FID_SUPPORTED_EFFECTS_UDCC" 12 +User Data Content Change .IP "NVME_FID_SUPPORTED_EFFECTS_NCC" 12 +Namespace Capability Change .IP "NVME_FID_SUPPORTED_EFFECTS_NIC" 12 +Namespace Inventory Change .IP "NVME_FID_SUPPORTED_EFFECTS_CCC" 12 +Controller Capability Change .IP "NVME_FID_SUPPORTED_EFFECTS_UUID_SEL" 12 +UUID Selection Supported .IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_SHIFT" 12 +FID Scope Shift .IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_MASK" 12 +FID Scope Mask .IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_NS" 12 +Namespace Scope .IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_CTRL" 12 +Controller Scope .IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_NVM_SET" 12 +NVM Set Scope .IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_ENDGRP" 12 +Endurance Group Scope .IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_DOMAIN" 12 +Domain Scope .IP "NVME_FID_SUPPORTED_EFFECTS_SCOPE_NSS" 12 -.SH "Description" -FID Supported and Effects Data Structure definitions +NVM Subsystem Scope diff --git a/doc/man/nvme_fid_supported_effects_log.2 b/doc/man/nvme_fid_supported_effects_log.2 index 6603c45..f9529e1 100644 --- a/doc/man/nvme_fid_supported_effects_log.2 +++ b/doc/man/nvme_fid_supported_effects_log.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_fid_supported_effects_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_fid_supported_effects_log" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_fid_supported_effects_log \- +struct nvme_fid_supported_effects_log \- Feature Identifiers Supported and Effects .SH SYNOPSIS struct nvme_fid_supported_effects_log { .br @@ -13,5 +13,3 @@ struct nvme_fid_supported_effects_log { .SH Members .IP "fid_support" 12 Feature Identifier Supported -.SH "Description" -Feature Identifiers Supported and Effects (Log Identifier 12h) diff --git a/doc/man/nvme_firmware_slot.2 b/doc/man/nvme_firmware_slot.2 index 61524c7..2b685f0 100644 --- a/doc/man/nvme_firmware_slot.2 +++ b/doc/man/nvme_firmware_slot.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_firmware_slot" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_firmware_slot" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_firmware_slot \- +struct nvme_firmware_slot \- Firmware Slot Information Log .SH SYNOPSIS struct nvme_firmware_slot { .br diff --git a/doc/man/nvme_first_host.2 b/doc/man/nvme_first_host.2 index bfad78d..dd97362 100644 --- a/doc/man/nvme_first_host.2 +++ b/doc/man/nvme_first_host.2 @@ -1,4 +1,4 @@ -.TH "nvme_first_host" 9 "nvme_first_host" "April 2022" "libnvme API manual" LINUX +.TH "nvme_first_host" 9 "nvme_first_host" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_first_host \- Start host iterator .SH SYNOPSIS diff --git a/doc/man/nvme_first_subsystem.2 b/doc/man/nvme_first_subsystem.2 index c47b3d9..493c657 100644 --- a/doc/man/nvme_first_subsystem.2 +++ b/doc/man/nvme_first_subsystem.2 @@ -1,4 +1,4 @@ -.TH "nvme_first_subsystem" 9 "nvme_first_subsystem" "April 2022" "libnvme API manual" LINUX +.TH "nvme_first_subsystem" 9 "nvme_first_subsystem" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_first_subsystem \- Start subsystem iterator .SH SYNOPSIS diff --git a/doc/man/nvme_flush.2 b/doc/man/nvme_flush.2 index 251958e..d866062 100644 --- a/doc/man/nvme_flush.2 +++ b/doc/man/nvme_flush.2 @@ -1,4 +1,4 @@ -.TH "nvme_flush" 9 "nvme_flush" "April 2022" "libnvme API manual" LINUX +.TH "nvme_flush" 9 "nvme_flush" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_flush \- Send an nvme flush command .SH SYNOPSIS diff --git a/doc/man/nvme_for_each_host.2 b/doc/man/nvme_for_each_host.2 index 08e4912..bc71bd0 100644 --- a/doc/man/nvme_for_each_host.2 +++ b/doc/man/nvme_for_each_host.2 @@ -1,4 +1,4 @@ -.TH "nvme_for_each_host" 9 "nvme_for_each_host" "April 2022" "libnvme API manual" LINUX +.TH "nvme_for_each_host" 9 "nvme_for_each_host" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_for_each_host \- Traverse host list .SH SYNOPSIS diff --git a/doc/man/nvme_for_each_host_safe.2 b/doc/man/nvme_for_each_host_safe.2 index 04f31fe..0f0886f 100644 --- a/doc/man/nvme_for_each_host_safe.2 +++ b/doc/man/nvme_for_each_host_safe.2 @@ -1,4 +1,4 @@ -.TH "nvme_for_each_host_safe" 9 "nvme_for_each_host_safe" "April 2022" "libnvme API manual" LINUX +.TH "nvme_for_each_host_safe" 9 "nvme_for_each_host_safe" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_for_each_host_safe \- Traverse host list .SH SYNOPSIS diff --git a/doc/man/nvme_for_each_subsystem.2 b/doc/man/nvme_for_each_subsystem.2 index 7f50b64..abc02e2 100644 --- a/doc/man/nvme_for_each_subsystem.2 +++ b/doc/man/nvme_for_each_subsystem.2 @@ -1,4 +1,4 @@ -.TH "nvme_for_each_subsystem" 9 "nvme_for_each_subsystem" "April 2022" "libnvme API manual" LINUX +.TH "nvme_for_each_subsystem" 9 "nvme_for_each_subsystem" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_for_each_subsystem \- Traverse subsystems .SH SYNOPSIS diff --git a/doc/man/nvme_for_each_subsystem_safe.2 b/doc/man/nvme_for_each_subsystem_safe.2 index b03d683..1a5cde9 100644 --- a/doc/man/nvme_for_each_subsystem_safe.2 +++ b/doc/man/nvme_for_each_subsystem_safe.2 @@ -1,4 +1,4 @@ -.TH "nvme_for_each_subsystem_safe" 9 "nvme_for_each_subsystem_safe" "April 2022" "libnvme API manual" LINUX +.TH "nvme_for_each_subsystem_safe" 9 "nvme_for_each_subsystem_safe" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_for_each_subsystem_safe \- Traverse subsystems .SH SYNOPSIS diff --git a/doc/man/nvme_format_nvm.2 b/doc/man/nvme_format_nvm.2 index 60ffa5b..bf53c5c 100644 --- a/doc/man/nvme_format_nvm.2 +++ b/doc/man/nvme_format_nvm.2 @@ -1,4 +1,4 @@ -.TH "nvme_format_nvm" 9 "nvme_format_nvm" "April 2022" "libnvme API manual" LINUX +.TH "nvme_format_nvm" 9 "nvme_format_nvm" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_format_nvm \- Format nvme namespace(s) .SH SYNOPSIS diff --git a/doc/man/nvme_format_nvm_args.2 b/doc/man/nvme_format_nvm_args.2 deleted file mode 100644 index 53f4fcb..0000000 --- a/doc/man/nvme_format_nvm_args.2 +++ /dev/null @@ -1,52 +0,0 @@ -.TH "libnvme" 9 "struct nvme_format_nvm_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_format_nvm_args \- Arguments for the Format Nvme Namespace command -.SH SYNOPSIS -struct nvme_format_nvm_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_cmd_format_mset mset;" -.br -.BI " enum nvme_cmd_format_pi pi;" -.br -.BI " enum nvme_cmd_format_pil pil;" -.br -.BI " enum nvme_cmd_format_ses ses;" -.br -.BI " __u8 lbaf;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "args_size" 12 -Size of \fIstruct nvme_format_nvm_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Set to override default timeout to this value in milliseconds; -useful for long running formats. 0 will use system default. -.IP "nsid" 12 -Namespace ID to format -.IP "mset" 12 -Metadata settings (extended or separated), true if extended -.IP "pi" 12 -Protection information type -.IP "pil" 12 -Protection information location (beginning or end), true if end -.IP "ses" 12 -Secure erase settings -.IP "lbaf" 12 -Logical block address format diff --git a/doc/man/nvme_format_nvm_compln_event.2 b/doc/man/nvme_format_nvm_compln_event.2 index d53651a..c07fa3a 100644 --- a/doc/man/nvme_format_nvm_compln_event.2 +++ b/doc/man/nvme_format_nvm_compln_event.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_format_nvm_compln_event" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_format_nvm_compln_event" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_format_nvm_compln_event \- +struct nvme_format_nvm_compln_event \- Format NVM Completion Event Data .SH SYNOPSIS struct nvme_format_nvm_compln_event { .br diff --git a/doc/man/nvme_format_nvm_start_event.2 b/doc/man/nvme_format_nvm_start_event.2 index cff8f5f..78f0a80 100644 --- a/doc/man/nvme_format_nvm_start_event.2 +++ b/doc/man/nvme_format_nvm_start_event.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_format_nvm_start_event" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_format_nvm_start_event" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_format_nvm_start_event \- +struct nvme_format_nvm_start_event \- Format NVM Start Event Data .SH SYNOPSIS struct nvme_format_nvm_start_event { .br diff --git a/doc/man/nvme_free_ctrl.2 b/doc/man/nvme_free_ctrl.2 index e350001..e2b1100 100644 --- a/doc/man/nvme_free_ctrl.2 +++ b/doc/man/nvme_free_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_free_ctrl" 9 "nvme_free_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_free_ctrl" 9 "nvme_free_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_free_ctrl \- Free controller .SH SYNOPSIS diff --git a/doc/man/nvme_free_host.2 b/doc/man/nvme_free_host.2 index a1393ac..ecd1b2b 100644 --- a/doc/man/nvme_free_host.2 +++ b/doc/man/nvme_free_host.2 @@ -1,4 +1,4 @@ -.TH "nvme_free_host" 9 "nvme_free_host" "April 2022" "libnvme API manual" LINUX +.TH "nvme_free_host" 9 "nvme_free_host" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_free_host \- Free nvme_host_t object .SH SYNOPSIS diff --git a/doc/man/nvme_free_ns.2 b/doc/man/nvme_free_ns.2 index f8ad3e8..6f878af 100644 --- a/doc/man/nvme_free_ns.2 +++ b/doc/man/nvme_free_ns.2 @@ -1,4 +1,4 @@ -.TH "nvme_free_ns" 9 "nvme_free_ns" "April 2022" "libnvme API manual" LINUX +.TH "nvme_free_ns" 9 "nvme_free_ns" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_free_ns \- Free a namespace object .SH SYNOPSIS diff --git a/doc/man/nvme_free_subsystem.2 b/doc/man/nvme_free_subsystem.2 index 121fc6c..81bd3f3 100644 --- a/doc/man/nvme_free_subsystem.2 +++ b/doc/man/nvme_free_subsystem.2 @@ -1,4 +1,4 @@ -.TH "nvme_free_subsystem" 9 "nvme_free_subsystem" "April 2022" "libnvme API manual" LINUX +.TH "nvme_free_subsystem" 9 "nvme_free_subsystem" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_free_subsystem \- Free a subsystem .SH SYNOPSIS diff --git a/doc/man/nvme_free_tree.2 b/doc/man/nvme_free_tree.2 index d819425..249e3a0 100644 --- a/doc/man/nvme_free_tree.2 +++ b/doc/man/nvme_free_tree.2 @@ -1,4 +1,4 @@ -.TH "nvme_free_tree" 9 "nvme_free_tree" "April 2022" "libnvme API manual" LINUX +.TH "nvme_free_tree" 9 "nvme_free_tree" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_free_tree \- Free root object .SH SYNOPSIS diff --git a/doc/man/nvme_fw_commit.2 b/doc/man/nvme_fw_commit.2 index a9d1f20..8844a26 100644 --- a/doc/man/nvme_fw_commit.2 +++ b/doc/man/nvme_fw_commit.2 @@ -1,4 +1,4 @@ -.TH "nvme_fw_commit" 9 "nvme_fw_commit" "April 2022" "libnvme API manual" LINUX +.TH "nvme_fw_commit" 9 "nvme_fw_commit" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_fw_commit \- Commit firmware using the specified action .SH SYNOPSIS diff --git a/doc/man/nvme_fw_commit_args.2 b/doc/man/nvme_fw_commit_args.2 deleted file mode 100644 index 81236ed..0000000 --- a/doc/man/nvme_fw_commit_args.2 +++ /dev/null @@ -1,39 +0,0 @@ -.TH "libnvme" 9 "struct nvme_fw_commit_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_fw_commit_args \- Arguments for the NVMe Firmware Commit command -.SH SYNOPSIS -struct nvme_fw_commit_args { -.br -.BI " __u32 *result;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " enum nvme_fw_commit_ca action;" -.br -.BI " __u8 slot;" -.br -.BI " bool bpid;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "args_size" 12 -Size of \fIstruct nvme_fw_commit_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "action" 12 -Action to use for the firmware image, see \fIenum nvme_fw_commit_ca\fP -.IP "slot" 12 -Firmware slot to commit the downloaded image -.IP "bpid" 12 -Set to true to select the boot partition id diff --git a/doc/man/nvme_fw_commit_ca.2 b/doc/man/nvme_fw_commit_ca.2 index 90194e8..ff0e3af 100644 --- a/doc/man/nvme_fw_commit_ca.2 +++ b/doc/man/nvme_fw_commit_ca.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_fw_commit_ca" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_fw_commit_ca" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_fw_commit_ca \- +enum nvme_fw_commit_ca \- Firmware Commit - Commit Action .SH SYNOPSIS enum nvme_fw_commit_ca { .br @@ -55,5 +55,5 @@ Partition specified by the Boot Partition ID field. .IP "NVME_FW_COMMIT_CA_ACTIVATE_BOOT_PARTITION" 12 Mark the Boot Partition specified in -the BPID field as active and update +the BPID field as active and update BPINFO.ABPID. diff --git a/doc/man/nvme_fw_commit_event.2 b/doc/man/nvme_fw_commit_event.2 index 30bd35f..24e0026 100644 --- a/doc/man/nvme_fw_commit_event.2 +++ b/doc/man/nvme_fw_commit_event.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_fw_commit_event" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_fw_commit_event" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_fw_commit_event \- +struct nvme_fw_commit_event \- Firmware Commit Event Data .SH SYNOPSIS struct nvme_fw_commit_event { .br diff --git a/doc/man/nvme_fw_download.2 b/doc/man/nvme_fw_download.2 index e810902..fd43815 100644 --- a/doc/man/nvme_fw_download.2 +++ b/doc/man/nvme_fw_download.2 @@ -1,4 +1,4 @@ -.TH "nvme_fw_download" 9 "nvme_fw_download" "April 2022" "libnvme API manual" LINUX +.TH "nvme_fw_download" 9 "nvme_fw_download" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_fw_download \- Download part or all of a firmware image to the controller .SH SYNOPSIS diff --git a/doc/man/nvme_fw_download_args.2 b/doc/man/nvme_fw_download_args.2 deleted file mode 100644 index 46ba23a..0000000 --- a/doc/man/nvme_fw_download_args.2 +++ /dev/null @@ -1,39 +0,0 @@ -.TH "libnvme" 9 "struct nvme_fw_download_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_fw_download_args \- Arguments for the NVMe Firmware Download command -.SH SYNOPSIS -struct nvme_fw_download_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 offset;" -.br -.BI " __u32 data_len;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "data" 12 -Userspace address of the firmware data -.IP "args_size" 12 -Size of \fIstruct nvme_fw_download_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "offset" 12 -Offset in the firmware data -.IP "data_len" 12 -Length of data in this command in bytes diff --git a/doc/man/nvme_fw_download_seq.2 b/doc/man/nvme_fw_download_seq.2 index 9afb52c..b040a40 100644 --- a/doc/man/nvme_fw_download_seq.2 +++ b/doc/man/nvme_fw_download_seq.2 @@ -1,4 +1,4 @@ -.TH "nvme_fw_download_seq" 9 "nvme_fw_download_seq" "April 2022" "libnvme API manual" LINUX +.TH "nvme_fw_download_seq" 9 "nvme_fw_download_seq" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_fw_download_seq \- Firmware download sequence .SH SYNOPSIS @@ -16,7 +16,7 @@ Total size of the firmware image to transfer .IP "xfer" 12 Maximum size to send with each partial transfer .IP "offset" 12 -Starting offset to send with this firmware downlaod +Starting offset to send with this firmware download .IP "buf" 12 Address of buffer containing all or part of the firmware image. .SH "RETURN" diff --git a/doc/man/nvme_gen_dhchap_key.2 b/doc/man/nvme_gen_dhchap_key.2 index b9a0866..1e56703 100644 --- a/doc/man/nvme_gen_dhchap_key.2 +++ b/doc/man/nvme_gen_dhchap_key.2 @@ -1,4 +1,4 @@ -.TH "nvme_gen_dhchap_key" 9 "nvme_gen_dhchap_key" "April 2022" "libnvme API manual" LINUX +.TH "nvme_gen_dhchap_key" 9 "nvme_gen_dhchap_key" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_gen_dhchap_key \- DH-HMAC-CHAP key generation .SH SYNOPSIS diff --git a/doc/man/nvme_get_ana_log_len.2 b/doc/man/nvme_get_ana_log_len.2 index 9c2efec..59c553a 100644 --- a/doc/man/nvme_get_ana_log_len.2 +++ b/doc/man/nvme_get_ana_log_len.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_ana_log_len" 9 "nvme_get_ana_log_len" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_ana_log_len" 9 "nvme_get_ana_log_len" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_ana_log_len \- Retreive size of the current ANA log +nvme_get_ana_log_len \- Retrieve size of the current ANA log .SH SYNOPSIS .B "int" nvme_get_ana_log_len .BI "(int fd " "," diff --git a/doc/man/nvme_get_attr.2 b/doc/man/nvme_get_attr.2 index 2c52587..ffb8a90 100644 --- a/doc/man/nvme_get_attr.2 +++ b/doc/man/nvme_get_attr.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_attr" 9 "nvme_get_attr" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_attr" 9 "nvme_get_attr" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_attr \- Read sysfs attribute .SH SYNOPSIS diff --git a/doc/man/nvme_get_ctrl_attr.2 b/doc/man/nvme_get_ctrl_attr.2 index 6ec20f6..f012f5a 100644 --- a/doc/man/nvme_get_ctrl_attr.2 +++ b/doc/man/nvme_get_ctrl_attr.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_ctrl_attr" 9 "nvme_get_ctrl_attr" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_ctrl_attr" 9 "nvme_get_ctrl_attr" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_ctrl_attr \- Read controller sysfs attribute .SH SYNOPSIS diff --git a/doc/man/nvme_get_ctrl_telemetry.2 b/doc/man/nvme_get_ctrl_telemetry.2 index c77da5f..7020b4c 100644 --- a/doc/man/nvme_get_ctrl_telemetry.2 +++ b/doc/man/nvme_get_ctrl_telemetry.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_ctrl_telemetry" 9 "nvme_get_ctrl_telemetry" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_ctrl_telemetry" 9 "nvme_get_ctrl_telemetry" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_ctrl_telemetry \- Get controller telemetry log .SH SYNOPSIS diff --git a/doc/man/nvme_get_directive_receive_length.2 b/doc/man/nvme_get_directive_receive_length.2 index 54dd32b..6cf3253 100644 --- a/doc/man/nvme_get_directive_receive_length.2 +++ b/doc/man/nvme_get_directive_receive_length.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_directive_receive_length" 9 "nvme_get_directive_receive_length" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_directive_receive_length" 9 "nvme_get_directive_receive_length" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_directive_receive_length \- +nvme_get_directive_receive_length \- Get directive receive length .SH SYNOPSIS .B "int" nvme_get_directive_receive_length .BI "(enum nvme_directive_dtype dtype " "," diff --git a/doc/man/nvme_get_feature_length.2 b/doc/man/nvme_get_feature_length.2 index c8f66a0..3d616ac 100644 --- a/doc/man/nvme_get_feature_length.2 +++ b/doc/man/nvme_get_feature_length.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_feature_length" 9 "nvme_get_feature_length" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_feature_length" 9 "nvme_get_feature_length" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_feature_length \- Retreive the command payload length for a specific feature identifier .SH SYNOPSIS diff --git a/doc/man/nvme_get_features.2 b/doc/man/nvme_get_features.2 index df6d662..904c7ef 100644 --- a/doc/man/nvme_get_features.2 +++ b/doc/man/nvme_get_features.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_features" 9 "nvme_get_features" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features" 9 "nvme_get_features" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_features \- Retrieve a feature attribute .SH SYNOPSIS diff --git a/doc/man/nvme_get_features_arbitration.2 b/doc/man/nvme_get_features_arbitration.2 index b6a5fb5..7366722 100644 --- a/doc/man/nvme_get_features_arbitration.2 +++ b/doc/man/nvme_get_features_arbitration.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_arbitration" 9 "nvme_get_features_arbitration" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_arbitration" 9 "nvme_get_features_arbitration" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_arbitration \- +nvme_get_features_arbitration \- Get arbitration feature .SH SYNOPSIS .B "int" nvme_get_features_arbitration .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_args.2 b/doc/man/nvme_get_features_args.2 deleted file mode 100644 index ea214fa..0000000 --- a/doc/man/nvme_get_features_args.2 +++ /dev/null @@ -1,56 +0,0 @@ -.TH "libnvme" 9 "struct nvme_get_features_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_get_features_args \- Arguments for the NVMe Admin Get Feature command -.SH SYNOPSIS -struct nvme_get_features_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_get_features_sel sel;" -.br -.BI " __u32 cdw11;" -.br -.BI " __u32 data_len;" -.br -.BI " __u8 fid;" -.br -.BI " __u8 uuidx;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "data" 12 -User address of feature data, if applicable -.IP "args_size" 12 -Size of \fIstruct nvme_get_features_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace ID, if applicable -.IP "sel" 12 -Select which type of attribute to return, -see \fIenum nvme_get_features_sel\fP -.IP "cdw11" 12 -Feature specific command dword11 field -.IP "data_len" 12 -Length of feature data, if applicable, in bytes -.IP "fid" 12 -Feature identifier, see \fIenum nvme_features_id\fP -.IP "uuidx" 12 -UUID Index for differentiating vendor specific encoding diff --git a/doc/man/nvme_get_features_async_event.2 b/doc/man/nvme_get_features_async_event.2 index ffcefe9..cfc97e8 100644 --- a/doc/man/nvme_get_features_async_event.2 +++ b/doc/man/nvme_get_features_async_event.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_async_event" 9 "nvme_get_features_async_event" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_async_event" 9 "nvme_get_features_async_event" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_async_event \- +nvme_get_features_async_event \- Get asynchronous event feature .SH SYNOPSIS .B "int" nvme_get_features_async_event .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_auto_pst.2 b/doc/man/nvme_get_features_auto_pst.2 index 56824c9..d9a7581 100644 --- a/doc/man/nvme_get_features_auto_pst.2 +++ b/doc/man/nvme_get_features_auto_pst.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_auto_pst" 9 "nvme_get_features_auto_pst" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_auto_pst" 9 "nvme_get_features_auto_pst" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_auto_pst \- +nvme_get_features_auto_pst \- Get autonomous power state feature .SH SYNOPSIS .B "int" nvme_get_features_auto_pst .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_data.2 b/doc/man/nvme_get_features_data.2 index 02b82e4..165d198 100644 --- a/doc/man/nvme_get_features_data.2 +++ b/doc/man/nvme_get_features_data.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_features_data" 9 "nvme_get_features_data" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_data" 9 "nvme_get_features_data" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_features_data \- Helper function for @nvme_get_features() .SH SYNOPSIS @@ -22,3 +22,6 @@ Length of feature data, if applicable, in bytes User address of feature data, if applicable .IP "result" 12 The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_endurance_event_cfg.2 b/doc/man/nvme_get_features_endurance_event_cfg.2 index 6087ec5..35ee22e 100644 --- a/doc/man/nvme_get_features_endurance_event_cfg.2 +++ b/doc/man/nvme_get_features_endurance_event_cfg.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_endurance_event_cfg" 9 "nvme_get_features_endurance_event_cfg" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_endurance_event_cfg" 9 "nvme_get_features_endurance_event_cfg" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_endurance_event_cfg \- +nvme_get_features_endurance_event_cfg \- Get endurance event config feature .SH SYNOPSIS .B "int" nvme_get_features_endurance_event_cfg .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_err_recovery.2 b/doc/man/nvme_get_features_err_recovery.2 index ab1bf69..f43ba60 100644 --- a/doc/man/nvme_get_features_err_recovery.2 +++ b/doc/man/nvme_get_features_err_recovery.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_err_recovery" 9 "nvme_get_features_err_recovery" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_err_recovery" 9 "nvme_get_features_err_recovery" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_err_recovery \- +nvme_get_features_err_recovery \- Get error recovery feature .SH SYNOPSIS .B "int" nvme_get_features_err_recovery .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_hctm.2 b/doc/man/nvme_get_features_hctm.2 index d0a7d2b..f478888 100644 --- a/doc/man/nvme_get_features_hctm.2 +++ b/doc/man/nvme_get_features_hctm.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_hctm" 9 "nvme_get_features_hctm" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_hctm" 9 "nvme_get_features_hctm" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_hctm \- +nvme_get_features_hctm \- Get thermal management feature .SH SYNOPSIS .B "int" nvme_get_features_hctm .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_host_behavior.2 b/doc/man/nvme_get_features_host_behavior.2 index 720a2a6..ff98eb2 100644 --- a/doc/man/nvme_get_features_host_behavior.2 +++ b/doc/man/nvme_get_features_host_behavior.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_host_behavior" 9 "nvme_get_features_host_behavior" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_host_behavior" 9 "nvme_get_features_host_behavior" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_host_behavior \- +nvme_get_features_host_behavior \- Get host behavior feature .SH SYNOPSIS .B "int" nvme_get_features_host_behavior .BI "(int fd " "," @@ -13,7 +13,7 @@ File descriptor of nvme device .IP "sel" 12 Select which type of attribute to return, see \fIenum nvme_get_features_sel\fP .IP "data" 12 -Poniter to structure nvme_feat_host_behavior +Pointer to structure nvme_feat_host_behavior .IP "result" 12 The command completion result from CQE dword0 .SH "RETURN" diff --git a/doc/man/nvme_get_features_host_id.2 b/doc/man/nvme_get_features_host_id.2 index 86e91ce..b1a25d7 100644 --- a/doc/man/nvme_get_features_host_id.2 +++ b/doc/man/nvme_get_features_host_id.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_host_id" 9 "nvme_get_features_host_id" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_host_id" 9 "nvme_get_features_host_id" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_host_id \- +nvme_get_features_host_id \- Get host id feature .SH SYNOPSIS .B "int" nvme_get_features_host_id .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_host_mem_buf.2 b/doc/man/nvme_get_features_host_mem_buf.2 index 2769024..65ecacd 100644 --- a/doc/man/nvme_get_features_host_mem_buf.2 +++ b/doc/man/nvme_get_features_host_mem_buf.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_host_mem_buf" 9 "nvme_get_features_host_mem_buf" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_host_mem_buf" 9 "nvme_get_features_host_mem_buf" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_host_mem_buf \- +nvme_get_features_host_mem_buf \- Get host memory buffer feature .SH SYNOPSIS .B "int" nvme_get_features_host_mem_buf .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_iocs_profile.2 b/doc/man/nvme_get_features_iocs_profile.2 index a771076..cae3a88 100644 --- a/doc/man/nvme_get_features_iocs_profile.2 +++ b/doc/man/nvme_get_features_iocs_profile.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_iocs_profile" 9 "nvme_get_features_iocs_profile" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_iocs_profile" 9 "nvme_get_features_iocs_profile" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_iocs_profile \- +nvme_get_features_iocs_profile \- Get IOCS profile feature .SH SYNOPSIS .B "int" nvme_get_features_iocs_profile .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_irq_coalesce.2 b/doc/man/nvme_get_features_irq_coalesce.2 index 4a7974a..9eac569 100644 --- a/doc/man/nvme_get_features_irq_coalesce.2 +++ b/doc/man/nvme_get_features_irq_coalesce.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_irq_coalesce" 9 "nvme_get_features_irq_coalesce" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_irq_coalesce" 9 "nvme_get_features_irq_coalesce" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_irq_coalesce \- +nvme_get_features_irq_coalesce \- Get IRQ coalesce feature .SH SYNOPSIS .B "int" nvme_get_features_irq_coalesce .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_irq_config.2 b/doc/man/nvme_get_features_irq_config.2 index 2d6a207..a164fa3 100644 --- a/doc/man/nvme_get_features_irq_config.2 +++ b/doc/man/nvme_get_features_irq_config.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_irq_config" 9 "nvme_get_features_irq_config" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_irq_config" 9 "nvme_get_features_irq_config" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_irq_config \- +nvme_get_features_irq_config \- Get IRQ config feature .SH SYNOPSIS .B "int" nvme_get_features_irq_config .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_kato.2 b/doc/man/nvme_get_features_kato.2 index cb9d29e..bc442cd 100644 --- a/doc/man/nvme_get_features_kato.2 +++ b/doc/man/nvme_get_features_kato.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_kato" 9 "nvme_get_features_kato" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_kato" 9 "nvme_get_features_kato" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_kato \- +nvme_get_features_kato \- Get keep alive timeout feature .SH SYNOPSIS .B "int" nvme_get_features_kato .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_lba_range.2 b/doc/man/nvme_get_features_lba_range.2 index cdb80c6..0cfd3f4 100644 --- a/doc/man/nvme_get_features_lba_range.2 +++ b/doc/man/nvme_get_features_lba_range.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_lba_range" 9 "nvme_get_features_lba_range" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_lba_range" 9 "nvme_get_features_lba_range" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_lba_range \- +nvme_get_features_lba_range \- Get LBA range feature .SH SYNOPSIS .B "int" nvme_get_features_lba_range .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_lba_sts_interval.2 b/doc/man/nvme_get_features_lba_sts_interval.2 index a8ba856..62f0673 100644 --- a/doc/man/nvme_get_features_lba_sts_interval.2 +++ b/doc/man/nvme_get_features_lba_sts_interval.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_lba_sts_interval" 9 "nvme_get_features_lba_sts_interval" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_lba_sts_interval" 9 "nvme_get_features_lba_sts_interval" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_lba_sts_interval \- +nvme_get_features_lba_sts_interval \- Get LBA status information feature .SH SYNOPSIS .B "int" nvme_get_features_lba_sts_interval .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_nopsc.2 b/doc/man/nvme_get_features_nopsc.2 index 92b4e18..443f602 100644 --- a/doc/man/nvme_get_features_nopsc.2 +++ b/doc/man/nvme_get_features_nopsc.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_nopsc" 9 "nvme_get_features_nopsc" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_nopsc" 9 "nvme_get_features_nopsc" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_nopsc \- +nvme_get_features_nopsc \- Get non-operational power state feature .SH SYNOPSIS .B "int" nvme_get_features_nopsc .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_num_queues.2 b/doc/man/nvme_get_features_num_queues.2 index ff528b0..f09092d 100644 --- a/doc/man/nvme_get_features_num_queues.2 +++ b/doc/man/nvme_get_features_num_queues.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_num_queues" 9 "nvme_get_features_num_queues" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_num_queues" 9 "nvme_get_features_num_queues" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_num_queues \- +nvme_get_features_num_queues \- Get number of queues feature .SH SYNOPSIS .B "int" nvme_get_features_num_queues .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_plm_config.2 b/doc/man/nvme_get_features_plm_config.2 index c9994db..6bd20e2 100644 --- a/doc/man/nvme_get_features_plm_config.2 +++ b/doc/man/nvme_get_features_plm_config.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_plm_config" 9 "nvme_get_features_plm_config" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_plm_config" 9 "nvme_get_features_plm_config" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_plm_config \- +nvme_get_features_plm_config \- Get predictable latency feature .SH SYNOPSIS .B "int" nvme_get_features_plm_config .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_plm_window.2 b/doc/man/nvme_get_features_plm_window.2 index effac98..cc7185a 100644 --- a/doc/man/nvme_get_features_plm_window.2 +++ b/doc/man/nvme_get_features_plm_window.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_plm_window" 9 "nvme_get_features_plm_window" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_plm_window" 9 "nvme_get_features_plm_window" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_plm_window \- +nvme_get_features_plm_window \- Get window select feature .SH SYNOPSIS .B "int" nvme_get_features_plm_window .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_power_mgmt.2 b/doc/man/nvme_get_features_power_mgmt.2 index a8ab0f1..c5d1b0e 100644 --- a/doc/man/nvme_get_features_power_mgmt.2 +++ b/doc/man/nvme_get_features_power_mgmt.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_power_mgmt" 9 "nvme_get_features_power_mgmt" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_power_mgmt" 9 "nvme_get_features_power_mgmt" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_power_mgmt \- +nvme_get_features_power_mgmt \- Get power management feature .SH SYNOPSIS .B "int" nvme_get_features_power_mgmt .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_resv_mask.2 b/doc/man/nvme_get_features_resv_mask.2 index e197b46..f2de359 100644 --- a/doc/man/nvme_get_features_resv_mask.2 +++ b/doc/man/nvme_get_features_resv_mask.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_resv_mask" 9 "nvme_get_features_resv_mask" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_resv_mask" 9 "nvme_get_features_resv_mask" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_resv_mask \- +nvme_get_features_resv_mask \- Get reservation mask feature .SH SYNOPSIS .B "int" nvme_get_features_resv_mask .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_resv_persist.2 b/doc/man/nvme_get_features_resv_persist.2 index 2146dba..f7dcad3 100644 --- a/doc/man/nvme_get_features_resv_persist.2 +++ b/doc/man/nvme_get_features_resv_persist.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_resv_persist" 9 "nvme_get_features_resv_persist" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_resv_persist" 9 "nvme_get_features_resv_persist" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_resv_persist \- +nvme_get_features_resv_persist \- Get reservation persist feature .SH SYNOPSIS .B "int" nvme_get_features_resv_persist .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_rrl.2 b/doc/man/nvme_get_features_rrl.2 index 570cbdf..cf4086b 100644 --- a/doc/man/nvme_get_features_rrl.2 +++ b/doc/man/nvme_get_features_rrl.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_rrl" 9 "nvme_get_features_rrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_rrl" 9 "nvme_get_features_rrl" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_rrl \- +nvme_get_features_rrl \- Get read recovery level feature .SH SYNOPSIS .B "int" nvme_get_features_rrl .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_sanitize.2 b/doc/man/nvme_get_features_sanitize.2 index dd81fc1..6cde6ed 100644 --- a/doc/man/nvme_get_features_sanitize.2 +++ b/doc/man/nvme_get_features_sanitize.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_sanitize" 9 "nvme_get_features_sanitize" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_sanitize" 9 "nvme_get_features_sanitize" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_sanitize \- +nvme_get_features_sanitize \- Get sanitize feature .SH SYNOPSIS .B "int" nvme_get_features_sanitize .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_sel.2 b/doc/man/nvme_get_features_sel.2 index f2a9b86..dd2f303 100644 --- a/doc/man/nvme_get_features_sel.2 +++ b/doc/man/nvme_get_features_sel.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_get_features_sel" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_get_features_sel" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_get_features_sel \- +enum nvme_get_features_sel \- Get Features - Select .SH SYNOPSIS enum nvme_get_features_sel { .br diff --git a/doc/man/nvme_get_features_simple.2 b/doc/man/nvme_get_features_simple.2 index 26b4fea..5b63f52 100644 --- a/doc/man/nvme_get_features_simple.2 +++ b/doc/man/nvme_get_features_simple.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_features_simple" 9 "nvme_get_features_simple" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_simple" 9 "nvme_get_features_simple" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_features_simple \- Helper function for @nvme_get_features() .SH SYNOPSIS @@ -16,3 +16,6 @@ Feature identifier Namespace ID, if applicable .IP "result" 12 The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_features_sw_progress.2 b/doc/man/nvme_get_features_sw_progress.2 index 602237b..81a3cb9 100644 --- a/doc/man/nvme_get_features_sw_progress.2 +++ b/doc/man/nvme_get_features_sw_progress.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_sw_progress" 9 "nvme_get_features_sw_progress" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_sw_progress" 9 "nvme_get_features_sw_progress" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_sw_progress \- +nvme_get_features_sw_progress \- Get software progress feature .SH SYNOPSIS .B "int" nvme_get_features_sw_progress .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_temp_thresh.2 b/doc/man/nvme_get_features_temp_thresh.2 index 7b781f2..a49ef6e 100644 --- a/doc/man/nvme_get_features_temp_thresh.2 +++ b/doc/man/nvme_get_features_temp_thresh.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_temp_thresh" 9 "nvme_get_features_temp_thresh" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_temp_thresh" 9 "nvme_get_features_temp_thresh" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_temp_thresh \- +nvme_get_features_temp_thresh \- Get temperature threshold feature .SH SYNOPSIS .B "int" nvme_get_features_temp_thresh .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_timestamp.2 b/doc/man/nvme_get_features_timestamp.2 index 4828dd1..7624d4e 100644 --- a/doc/man/nvme_get_features_timestamp.2 +++ b/doc/man/nvme_get_features_timestamp.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_timestamp" 9 "nvme_get_features_timestamp" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_timestamp" 9 "nvme_get_features_timestamp" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_timestamp \- +nvme_get_features_timestamp \- Get timestamp feature .SH SYNOPSIS .B "int" nvme_get_features_timestamp .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_volatile_wc.2 b/doc/man/nvme_get_features_volatile_wc.2 index 9a3ca60..3dad5df 100644 --- a/doc/man/nvme_get_features_volatile_wc.2 +++ b/doc/man/nvme_get_features_volatile_wc.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_volatile_wc" 9 "nvme_get_features_volatile_wc" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_volatile_wc" 9 "nvme_get_features_volatile_wc" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_volatile_wc \- +nvme_get_features_volatile_wc \- Get volatile write cache feature .SH SYNOPSIS .B "int" nvme_get_features_volatile_wc .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_write_atomic.2 b/doc/man/nvme_get_features_write_atomic.2 index bd8cc59..05d13b5 100644 --- a/doc/man/nvme_get_features_write_atomic.2 +++ b/doc/man/nvme_get_features_write_atomic.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_write_atomic" 9 "nvme_get_features_write_atomic" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_write_atomic" 9 "nvme_get_features_write_atomic" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_write_atomic \- +nvme_get_features_write_atomic \- Get write atomic feature .SH SYNOPSIS .B "int" nvme_get_features_write_atomic .BI "(int fd " "," diff --git a/doc/man/nvme_get_features_write_protect.2 b/doc/man/nvme_get_features_write_protect.2 index 5c6bee6..849cdda 100644 --- a/doc/man/nvme_get_features_write_protect.2 +++ b/doc/man/nvme_get_features_write_protect.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_features_write_protect" 9 "nvme_get_features_write_protect" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_features_write_protect" 9 "nvme_get_features_write_protect" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_features_write_protect \- +nvme_get_features_write_protect \- Get write protect feature .SH SYNOPSIS .B "int" nvme_get_features_write_protect .BI "(int fd " "," diff --git a/doc/man/nvme_get_host_telemetry.2 b/doc/man/nvme_get_host_telemetry.2 index 2737ee2..568e438 100644 --- a/doc/man/nvme_get_host_telemetry.2 +++ b/doc/man/nvme_get_host_telemetry.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_host_telemetry" 9 "nvme_get_host_telemetry" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_host_telemetry" 9 "nvme_get_host_telemetry" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_host_telemetry \- Get host telemetry log .SH SYNOPSIS diff --git a/doc/man/nvme_get_lba_status.2 b/doc/man/nvme_get_lba_status.2 index 0a0d9cd..a444c6c 100644 --- a/doc/man/nvme_get_lba_status.2 +++ b/doc/man/nvme_get_lba_status.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_lba_status" 9 "nvme_get_lba_status" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_lba_status" 9 "nvme_get_lba_status" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_lba_status \- Retrieve information on possibly unrecoverable LBAs .SH SYNOPSIS diff --git a/doc/man/nvme_get_lba_status_args.2 b/doc/man/nvme_get_lba_status_args.2 deleted file mode 100644 index f12ab36..0000000 --- a/doc/man/nvme_get_lba_status_args.2 +++ /dev/null @@ -1,52 +0,0 @@ -.TH "libnvme" 9 "struct nvme_get_lba_status_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_get_lba_status_args \- Arguments for the NVMe Get LBA Status command -.SH SYNOPSIS -struct nvme_get_lba_status_args { -.br -.BI " __u64 slba;" -.br -.BI " __u32 *result;" -.br -.BI " struct nvme_lba_status *lbas;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " __u32 nsid;" -.br -.BI " __u32 mndw;" -.br -.BI " enum nvme_lba_status_atype atype;" -.br -.BI " __u16 rl;" -.br -.BI " -}; -.br - -.SH Members -.IP "slba" 12 -Starting logical block address to check statuses -.IP "result" 12 -The command completion result from CQE dword0 -.IP "lbas" 12 -Data payload to return status descriptors -.IP "args_size" 12 -Size of \fIstruct nvme_get_lba_status_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace ID to retrieve LBA status -.IP "mndw" 12 -Maximum number of dwords to return -.IP "atype" 12 -Action type mechanism to determine LBA status desctriptors to -return, see \fIenum nvme_lba_status_atype\fP -.IP "rl" 12 -Range length from slba to perform the action diff --git a/doc/man/nvme_get_lba_status_log.2 b/doc/man/nvme_get_lba_status_log.2 index 558fbaf..57fa028 100644 --- a/doc/man/nvme_get_lba_status_log.2 +++ b/doc/man/nvme_get_lba_status_log.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_lba_status_log" 9 "nvme_get_lba_status_log" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_lba_status_log" 9 "nvme_get_lba_status_log" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_lba_status_log \- Retreive the LBA Status log page +nvme_get_lba_status_log \- Retrieve the LBA Status log page .SH SYNOPSIS .B "int" nvme_get_lba_status_log .BI "(int fd " "," @@ -12,7 +12,7 @@ File descriptor of the nvme device .IP "rae" 12 Retain asynchronous events .IP "log" 12 -On success, set to the value of the allocated and retreived log. +On success, set to the value of the allocated and retrieved log. .SH "RETURN" The nvme command status if a response was received (see \fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log.2 b/doc/man/nvme_get_log.2 index e0a57ea..ba205c8 100644 --- a/doc/man/nvme_get_log.2 +++ b/doc/man/nvme_get_log.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_log" 9 "nvme_get_log" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log" 9 "nvme_get_log" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_log \- NVMe Admin Get Log command .SH SYNOPSIS diff --git a/doc/man/nvme_get_log_ana.2 b/doc/man/nvme_get_log_ana.2 index 24d038e..e76eab7 100644 --- a/doc/man/nvme_get_log_ana.2 +++ b/doc/man/nvme_get_log_ana.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_ana" 9 "nvme_get_log_ana" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_ana" 9 "nvme_get_log_ana" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_ana \- +nvme_get_log_ana \- Retrieve Asymmetric Namespace Access log page .SH SYNOPSIS .B "int" nvme_get_log_ana .BI "(int fd " "," @@ -27,7 +27,7 @@ This log consists of a header describing the log and descriptors containing the asymmetric namespace access information for ANA Groups that contain namespaces that are attached to the controller processing the command. -See \fIstruct nvme_ana_rsp_hdr\fP for the defintion of the returned structure. +See \fIstruct nvme_ana_rsp_hdr\fP for the definition of the returned structure. .SH "RETURN" The nvme command status if a response was received (see \fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_ana_groups.2 b/doc/man/nvme_get_log_ana_groups.2 index 8e1f5c6..b9421ed 100644 --- a/doc/man/nvme_get_log_ana_groups.2 +++ b/doc/man/nvme_get_log_ana_groups.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_ana_groups" 9 "nvme_get_log_ana_groups" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_ana_groups" 9 "nvme_get_log_ana_groups" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_ana_groups \- +nvme_get_log_ana_groups \- Retrieve Asymmetric Namespace Access groups only log page .SH SYNOPSIS .B "int" nvme_get_log_ana_groups .BI "(int fd " "," @@ -17,4 +17,7 @@ The allocated length of the log page .IP "log" 12 User address to store the ana group log .SH "DESCRIPTION" -See \fIstruct nvme_ana_group_desc\fP for the defintion of the returned structure. +See \fIstruct nvme_ana_group_desc\fP for the definition of the returned structure. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_args.2 b/doc/man/nvme_get_log_args.2 deleted file mode 100644 index 60a6db6..0000000 --- a/doc/man/nvme_get_log_args.2 +++ /dev/null @@ -1,74 +0,0 @@ -.TH "libnvme" 9 "struct nvme_get_log_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_get_log_args \- Arguments for the NVMe Admin Get Log command -.SH SYNOPSIS -struct nvme_get_log_args { -.br -.BI " __u64 lpo;" -.br -.BI " __u32 *result;" -.br -.BI " void *log;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " enum nvme_cmd_get_log_lid lid;" -.br -.BI " __u32 len;" -.br -.BI " __u32 nsid;" -.br -.BI " enum nvme_csi csi;" -.br -.BI " __u16 lsi;" -.br -.BI " __u8 lsp;" -.br -.BI " __u8 uuidx;" -.br -.BI " bool rae;" -.br -.BI " bool ot;" -.br -.BI " -}; -.br - -.SH Members -.IP "lpo" 12 -Log page offset for partial log transfers -.IP "result" 12 -The command completion result from CQE dword0 -.IP "log" 12 -User space destination address to transfer the data -.IP "args_size" 12 -Length of the structure -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "lid" 12 -Log page identifier, see \fIenum nvme_cmd_get_log_lid\fP for known -values -.IP "len" 12 -Length of provided user buffer to hold the log data in bytes -.IP "nsid" 12 -Namespace identifier, if applicable -.IP "csi" 12 -Command set identifier, see \fIenum nvme_csi\fP for known values -.IP "lsi" 12 -Log Specific Identifier -.IP "lsp" 12 -Log specific field -.IP "uuidx" 12 -UUID selection, if supported -.IP "rae" 12 -Retain asynchronous events -.IP "ot" 12 -Offset Type; if set \fIlpo\fP specifies the index into the list -of data structures, otherwise \fIlpo\fP specifies the byte offset -into the log page. diff --git a/doc/man/nvme_get_log_boot_partition.2 b/doc/man/nvme_get_log_boot_partition.2 index b6917b1..d3ccb34 100644 --- a/doc/man/nvme_get_log_boot_partition.2 +++ b/doc/man/nvme_get_log_boot_partition.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_boot_partition" 9 "nvme_get_log_boot_partition" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_boot_partition" 9 "nvme_get_log_boot_partition" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_boot_partition \- +nvme_get_log_boot_partition \- Retrieve Boot Partition .SH SYNOPSIS .B "int" nvme_get_log_boot_partition .BI "(int fd " "," diff --git a/doc/man/nvme_get_log_changed_ns_list.2 b/doc/man/nvme_get_log_changed_ns_list.2 index ce4984d..f7d893e 100644 --- a/doc/man/nvme_get_log_changed_ns_list.2 +++ b/doc/man/nvme_get_log_changed_ns_list.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_log_changed_ns_list" 9 "nvme_get_log_changed_ns_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_changed_ns_list" 9 "nvme_get_log_changed_ns_list" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_log_changed_ns_list \- Retrieve namespace changed list .SH SYNOPSIS diff --git a/doc/man/nvme_get_log_cmd_effects.2 b/doc/man/nvme_get_log_cmd_effects.2 index b443981..9dc350e 100644 --- a/doc/man/nvme_get_log_cmd_effects.2 +++ b/doc/man/nvme_get_log_cmd_effects.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_log_cmd_effects" 9 "nvme_get_log_cmd_effects" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_cmd_effects" 9 "nvme_get_log_cmd_effects" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_log_cmd_effects \- Retrieve nvme command effects log .SH SYNOPSIS diff --git a/doc/man/nvme_get_log_create_telemetry_host.2 b/doc/man/nvme_get_log_create_telemetry_host.2 index 59328c7..5752f99 100644 --- a/doc/man/nvme_get_log_create_telemetry_host.2 +++ b/doc/man/nvme_get_log_create_telemetry_host.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_log_create_telemetry_host" 9 "nvme_get_log_create_telemetry_host" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_create_telemetry_host" 9 "nvme_get_log_create_telemetry_host" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_log_create_telemetry_host \- Create host telemetry log .SH SYNOPSIS @@ -10,3 +10,6 @@ nvme_get_log_create_telemetry_host \- Create host telemetry log File descriptor of nvme device .IP "log" 12 Userspace address of the log payload +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_device_self_test.2 b/doc/man/nvme_get_log_device_self_test.2 index 262e223..148ba00 100644 --- a/doc/man/nvme_get_log_device_self_test.2 +++ b/doc/man/nvme_get_log_device_self_test.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_log_device_self_test" 9 "nvme_get_log_device_self_test" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_device_self_test" 9 "nvme_get_log_device_self_test" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_log_device_self_test \- Retrieve the device self test log .SH SYNOPSIS diff --git a/doc/man/nvme_get_log_discovery.2 b/doc/man/nvme_get_log_discovery.2 index cc84ee9..15add7c 100644 --- a/doc/man/nvme_get_log_discovery.2 +++ b/doc/man/nvme_get_log_discovery.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_discovery" 9 "nvme_get_log_discovery" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_discovery" 9 "nvme_get_log_discovery" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_discovery \- +nvme_get_log_discovery \- Retrieve Discovery log page .SH SYNOPSIS .B "int" nvme_get_log_discovery .BI "(int fd " "," diff --git a/doc/man/nvme_get_log_endurance_group.2 b/doc/man/nvme_get_log_endurance_group.2 index 7a305f7..bfb2bf9 100644 --- a/doc/man/nvme_get_log_endurance_group.2 +++ b/doc/man/nvme_get_log_endurance_group.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_endurance_group" 9 "nvme_get_log_endurance_group" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_endurance_group" 9 "nvme_get_log_endurance_group" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_endurance_group \- +nvme_get_log_endurance_group \- Get Endurance Group log .SH SYNOPSIS .B "int" nvme_get_log_endurance_group .BI "(int fd " "," diff --git a/doc/man/nvme_get_log_endurance_grp_evt.2 b/doc/man/nvme_get_log_endurance_grp_evt.2 index 81f1536..abb5c5a 100644 --- a/doc/man/nvme_get_log_endurance_grp_evt.2 +++ b/doc/man/nvme_get_log_endurance_grp_evt.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_endurance_grp_evt" 9 "nvme_get_log_endurance_grp_evt" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_endurance_grp_evt" 9 "nvme_get_log_endurance_grp_evt" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_endurance_grp_evt \- +nvme_get_log_endurance_grp_evt \- Retrieve Rotational Media Information .SH SYNOPSIS .B "int" nvme_get_log_endurance_grp_evt .BI "(int fd " "," @@ -19,3 +19,6 @@ Offset to the start of the log page The allocated length of the log page .IP "log" 12 User address to store the log page +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_error.2 b/doc/man/nvme_get_log_error.2 index 2bcf0aa..8d653ec 100644 --- a/doc/man/nvme_get_log_error.2 +++ b/doc/man/nvme_get_log_error.2 @@ -1,10 +1,10 @@ -.TH "nvme_get_log_error" 9 "nvme_get_log_error" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_error" 9 "nvme_get_log_error" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_log_error \- Retrieve nvme error log .SH SYNOPSIS .B "int" nvme_get_log_error .BI "(int fd " "," -.BI "unsigned nr_entries " "," +.BI "unsigned int nr_entries " "," .BI "bool rae " "," .BI "struct nvme_error_log_page *err_log " ");" .SH ARGUMENTS diff --git a/doc/man/nvme_get_log_fid_supported_effects.2 b/doc/man/nvme_get_log_fid_supported_effects.2 index ebe2223..09c081e 100644 --- a/doc/man/nvme_get_log_fid_supported_effects.2 +++ b/doc/man/nvme_get_log_fid_supported_effects.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_fid_supported_effects" 9 "nvme_get_log_fid_supported_effects" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_fid_supported_effects" 9 "nvme_get_log_fid_supported_effects" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_fid_supported_effects \- +nvme_get_log_fid_supported_effects \- Retrieve Feature Identifiers Supported and Effects .SH SYNOPSIS .B "int" nvme_get_log_fid_supported_effects .BI "(int fd " "," diff --git a/doc/man/nvme_get_log_fw_slot.2 b/doc/man/nvme_get_log_fw_slot.2 index 5ab7744..7d4b4c1 100644 --- a/doc/man/nvme_get_log_fw_slot.2 +++ b/doc/man/nvme_get_log_fw_slot.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_log_fw_slot" 9 "nvme_get_log_fw_slot" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_fw_slot" 9 "nvme_get_log_fw_slot" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_log_fw_slot \- Retrieves the controller firmware log .SH SYNOPSIS diff --git a/doc/man/nvme_get_log_lba_status.2 b/doc/man/nvme_get_log_lba_status.2 index f339eaa..ae47b46 100644 --- a/doc/man/nvme_get_log_lba_status.2 +++ b/doc/man/nvme_get_log_lba_status.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_lba_status" 9 "nvme_get_log_lba_status" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_lba_status" 9 "nvme_get_log_lba_status" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_lba_status \- +nvme_get_log_lba_status \- Retrieve LBA Status .SH SYNOPSIS .B "int" nvme_get_log_lba_status .BI "(int fd " "," @@ -19,3 +19,6 @@ Offset to the start of the log page The allocated length of the log page .IP "log" 12 User address to store the log page +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_media_unit_stat.2 b/doc/man/nvme_get_log_media_unit_stat.2 index 8c40d10..a795a3b 100644 --- a/doc/man/nvme_get_log_media_unit_stat.2 +++ b/doc/man/nvme_get_log_media_unit_stat.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_media_unit_stat" 9 "nvme_get_log_media_unit_stat" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_media_unit_stat" 9 "nvme_get_log_media_unit_stat" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_media_unit_stat \- +nvme_get_log_media_unit_stat \- Retrieve Media Unit Status .SH SYNOPSIS .B "int" nvme_get_log_media_unit_stat .BI "(int fd " "," diff --git a/doc/man/nvme_get_log_mi_cmd_supported_effects.2 b/doc/man/nvme_get_log_mi_cmd_supported_effects.2 index 82e1aa7..7b9d965 100644 --- a/doc/man/nvme_get_log_mi_cmd_supported_effects.2 +++ b/doc/man/nvme_get_log_mi_cmd_supported_effects.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_mi_cmd_supported_effects" 9 "nvme_get_log_mi_cmd_supported_effects" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_mi_cmd_supported_effects" 9 "nvme_get_log_mi_cmd_supported_effects" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_mi_cmd_supported_effects \- displays the MI Commands Supported byt the controller +nvme_get_log_mi_cmd_supported_effects \- displays the MI Commands Supported by the controller .SH SYNOPSIS .B "int" nvme_get_log_mi_cmd_supported_effects .BI "(int fd " "," diff --git a/doc/man/nvme_get_log_page.2 b/doc/man/nvme_get_log_page.2 index 59edb54..e25d018 100644 --- a/doc/man/nvme_get_log_page.2 +++ b/doc/man/nvme_get_log_page.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_log_page" 9 "nvme_get_log_page" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_page" 9 "nvme_get_log_page" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_log_page \- Get log page data .SH SYNOPSIS diff --git a/doc/man/nvme_get_log_persistent_event.2 b/doc/man/nvme_get_log_persistent_event.2 index d95e984..cde6c1d 100644 --- a/doc/man/nvme_get_log_persistent_event.2 +++ b/doc/man/nvme_get_log_persistent_event.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_persistent_event" 9 "nvme_get_log_persistent_event" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_persistent_event" 9 "nvme_get_log_persistent_event" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_persistent_event \- +nvme_get_log_persistent_event \- Retrieve Persistent Event Log .SH SYNOPSIS .B "int" nvme_get_log_persistent_event .BI "(int fd " "," @@ -16,3 +16,6 @@ Action the controller should take during processing this command Size of \fIpevent_log\fP .IP "pevent_log" 12 User address to store the persistent event log +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_predictable_lat_event.2 b/doc/man/nvme_get_log_predictable_lat_event.2 index a796c95..c11957c 100644 --- a/doc/man/nvme_get_log_predictable_lat_event.2 +++ b/doc/man/nvme_get_log_predictable_lat_event.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_predictable_lat_event" 9 "nvme_get_log_predictable_lat_event" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_predictable_lat_event" 9 "nvme_get_log_predictable_lat_event" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_predictable_lat_event \- +nvme_get_log_predictable_lat_event \- Retrieve Predictable Latency Event Aggregate Log Page .SH SYNOPSIS .B "int" nvme_get_log_predictable_lat_event .BI "(int fd " "," @@ -19,3 +19,6 @@ Offset into the predictable latency event Length of provided user buffer to hold the log data in bytes .IP "log" 12 User address for log page data +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_predictable_lat_nvmset.2 b/doc/man/nvme_get_log_predictable_lat_nvmset.2 index 089c9d9..7f13696 100644 --- a/doc/man/nvme_get_log_predictable_lat_nvmset.2 +++ b/doc/man/nvme_get_log_predictable_lat_nvmset.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_predictable_lat_nvmset" 9 "nvme_get_log_predictable_lat_nvmset" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_predictable_lat_nvmset" 9 "nvme_get_log_predictable_lat_nvmset" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_predictable_lat_nvmset \- +nvme_get_log_predictable_lat_nvmset \- Predictable Latency Per NVM Set .SH SYNOPSIS .B "int" nvme_get_log_predictable_lat_nvmset .BI "(int fd " "," diff --git a/doc/man/nvme_get_log_reservation.2 b/doc/man/nvme_get_log_reservation.2 index af522a2..e542673 100644 --- a/doc/man/nvme_get_log_reservation.2 +++ b/doc/man/nvme_get_log_reservation.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_reservation" 9 "nvme_get_log_reservation" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_reservation" 9 "nvme_get_log_reservation" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_reservation \- +nvme_get_log_reservation \- Retrieve Reservation Notification .SH SYNOPSIS .B "int" nvme_get_log_reservation .BI "(int fd " "," @@ -13,3 +13,6 @@ File descriptor of nvme device Retain asynchronous events .IP "log" 12 User address to store the reservation log +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise diff --git a/doc/man/nvme_get_log_sanitize.2 b/doc/man/nvme_get_log_sanitize.2 index 7210a04..a288759 100644 --- a/doc/man/nvme_get_log_sanitize.2 +++ b/doc/man/nvme_get_log_sanitize.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_sanitize" 9 "nvme_get_log_sanitize" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_sanitize" 9 "nvme_get_log_sanitize" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_sanitize \- +nvme_get_log_sanitize \- Retrieve Sanitize Status .SH SYNOPSIS .B "int" nvme_get_log_sanitize .BI "(int fd " "," diff --git a/doc/man/nvme_get_log_smart.2 b/doc/man/nvme_get_log_smart.2 index 5e6c1e6..59db53d 100644 --- a/doc/man/nvme_get_log_smart.2 +++ b/doc/man/nvme_get_log_smart.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_log_smart" 9 "nvme_get_log_smart" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_smart" 9 "nvme_get_log_smart" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_log_smart \- Retrieve nvme smart log .SH SYNOPSIS diff --git a/doc/man/nvme_get_log_support_cap_config_list.2 b/doc/man/nvme_get_log_support_cap_config_list.2 index 9eaea26..2650623 100644 --- a/doc/man/nvme_get_log_support_cap_config_list.2 +++ b/doc/man/nvme_get_log_support_cap_config_list.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_support_cap_config_list" 9 "nvme_get_log_support_cap_config_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_support_cap_config_list" 9 "nvme_get_log_support_cap_config_list" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_support_cap_config_list \- +nvme_get_log_support_cap_config_list \- Retrieve Supported Capacity Configuration List .SH SYNOPSIS .B "int" nvme_get_log_support_cap_config_list .BI "(int fd " "," @@ -12,7 +12,7 @@ File descriptor of nvme device .IP "domid" 12 Domain Identifier selection, if supported .IP "cap" 12 --- undescribed -- +User address to store supported capabilities config list .SH "RETURN" The nvme command status if a response was received (see \fIenum nvme_status_field\fP) or -1 with errno set otherwise diff --git a/doc/man/nvme_get_log_supported_log_pages.2 b/doc/man/nvme_get_log_supported_log_pages.2 index 6376164..01fb122 100644 --- a/doc/man/nvme_get_log_supported_log_pages.2 +++ b/doc/man/nvme_get_log_supported_log_pages.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_log_supported_log_pages" 9 "nvme_get_log_supported_log_pages" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_supported_log_pages" 9 "nvme_get_log_supported_log_pages" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_log_supported_log_pages \- Retrieve nmve supported log pages .SH SYNOPSIS diff --git a/doc/man/nvme_get_log_telemetry_ctrl.2 b/doc/man/nvme_get_log_telemetry_ctrl.2 index 4d97df7..528deec 100644 --- a/doc/man/nvme_get_log_telemetry_ctrl.2 +++ b/doc/man/nvme_get_log_telemetry_ctrl.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_telemetry_ctrl" 9 "nvme_get_log_telemetry_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_telemetry_ctrl" 9 "nvme_get_log_telemetry_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_telemetry_ctrl \- +nvme_get_log_telemetry_ctrl \- Get Telemetry Controller-Initiated log page .SH SYNOPSIS .B "int" nvme_get_log_telemetry_ctrl .BI "(int fd " "," @@ -19,3 +19,9 @@ Offset into the telemetry data Length of provided user buffer to hold the log data in bytes .IP "log" 12 User address for log page data +.SH "DESCRIPTION" +Retrieves the Telemetry Controller-Initiated log page at the requested offset +using the previously existing capture. +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_get_log_telemetry_host.2 b/doc/man/nvme_get_log_telemetry_host.2 index de8a91a..ab29f9a 100644 --- a/doc/man/nvme_get_log_telemetry_host.2 +++ b/doc/man/nvme_get_log_telemetry_host.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_telemetry_host" 9 "nvme_get_log_telemetry_host" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_telemetry_host" 9 "nvme_get_log_telemetry_host" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_telemetry_host \- +nvme_get_log_telemetry_host \- Get Telemetry Host-Initiated log page .SH SYNOPSIS .B "int" nvme_get_log_telemetry_host .BI "(int fd " "," @@ -17,7 +17,7 @@ Length of provided user buffer to hold the log data in bytes .IP "log" 12 User address for log page data .SH "DESCRIPTION" -Retreives the Telemetry Host-Initiated log page at the requested offset +Retrieves the Telemetry Host-Initiated log page at the requested offset using the previously existing capture. .SH "RETURN" The nvme command status if a response was received (see diff --git a/doc/man/nvme_get_log_zns_changed_zones.2 b/doc/man/nvme_get_log_zns_changed_zones.2 index 8877aaa..474094a 100644 --- a/doc/man/nvme_get_log_zns_changed_zones.2 +++ b/doc/man/nvme_get_log_zns_changed_zones.2 @@ -1,6 +1,6 @@ -.TH "nvme_get_log_zns_changed_zones" 9 "nvme_get_log_zns_changed_zones" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_log_zns_changed_zones" 9 "nvme_get_log_zns_changed_zones" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_get_log_zns_changed_zones \- +nvme_get_log_zns_changed_zones \- Retrieve list of zones that have changed .SH SYNOPSIS .B "int" nvme_get_log_zns_changed_zones .BI "(int fd " "," diff --git a/doc/man/nvme_get_logical_block_size.2 b/doc/man/nvme_get_logical_block_size.2 index b8709eb..ee3d468 100644 --- a/doc/man/nvme_get_logical_block_size.2 +++ b/doc/man/nvme_get_logical_block_size.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_logical_block_size" 9 "nvme_get_logical_block_size" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_logical_block_size" 9 "nvme_get_logical_block_size" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_logical_block_size \- Retrieve block size .SH SYNOPSIS diff --git a/doc/man/nvme_get_new_host_telemetry.2 b/doc/man/nvme_get_new_host_telemetry.2 index f7bea6a..acfbc31 100644 --- a/doc/man/nvme_get_new_host_telemetry.2 +++ b/doc/man/nvme_get_new_host_telemetry.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_new_host_telemetry" 9 "nvme_get_new_host_telemetry" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_new_host_telemetry" 9 "nvme_get_new_host_telemetry" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_new_host_telemetry \- Get new host telemetry log .SH SYNOPSIS diff --git a/doc/man/nvme_get_ns_attr.2 b/doc/man/nvme_get_ns_attr.2 index 9d001d9..ea26983 100644 --- a/doc/man/nvme_get_ns_attr.2 +++ b/doc/man/nvme_get_ns_attr.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_ns_attr" 9 "nvme_get_ns_attr" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_ns_attr" 9 "nvme_get_ns_attr" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_ns_attr \- Read namespace sysfs attribute .SH SYNOPSIS diff --git a/doc/man/nvme_get_nsid.2 b/doc/man/nvme_get_nsid.2 index dcdfe02..319d1d8 100644 --- a/doc/man/nvme_get_nsid.2 +++ b/doc/man/nvme_get_nsid.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_nsid" 9 "nvme_get_nsid" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_nsid" 9 "nvme_get_nsid" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_nsid \- Retrieve the NSID from a namespace file descriptor .SH SYNOPSIS diff --git a/doc/man/nvme_get_path_attr.2 b/doc/man/nvme_get_path_attr.2 index ca3ed4f..3c6e6e9 100644 --- a/doc/man/nvme_get_path_attr.2 +++ b/doc/man/nvme_get_path_attr.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_path_attr" 9 "nvme_get_path_attr" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_path_attr" 9 "nvme_get_path_attr" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_path_attr \- Read path sysfs attribute .SH SYNOPSIS diff --git a/doc/man/nvme_get_property.2 b/doc/man/nvme_get_property.2 index 8988ae7..1b42216 100644 --- a/doc/man/nvme_get_property.2 +++ b/doc/man/nvme_get_property.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_property" 9 "nvme_get_property" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_property" 9 "nvme_get_property" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_property \- Get a controller property .SH SYNOPSIS diff --git a/doc/man/nvme_get_property_args.2 b/doc/man/nvme_get_property_args.2 deleted file mode 100644 index f7cb1f3..0000000 --- a/doc/man/nvme_get_property_args.2 +++ /dev/null @@ -1,31 +0,0 @@ -.TH "libnvme" 9 "struct nvme_get_property_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_get_property_args \- Arguments for NVMe Get Property command -.SH SYNOPSIS -struct nvme_get_property_args { -.br -.BI " __u64 *value;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " int offset;" -.br -.BI " -}; -.br - -.SH Members -.IP "value" 12 -Where the property's value will be stored on success -.IP "args_size" 12 -Size of \fIstruct nvme_get_property_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "offset" 12 -Property offset from the base to retrieve diff --git a/doc/man/nvme_get_subsys_attr.2 b/doc/man/nvme_get_subsys_attr.2 index 6d738ef..335dc1a 100644 --- a/doc/man/nvme_get_subsys_attr.2 +++ b/doc/man/nvme_get_subsys_attr.2 @@ -1,4 +1,4 @@ -.TH "nvme_get_subsys_attr" 9 "nvme_get_subsys_attr" "April 2022" "libnvme API manual" LINUX +.TH "nvme_get_subsys_attr" 9 "nvme_get_subsys_attr" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_get_subsys_attr \- Read subsystem sysfs attribute .SH SYNOPSIS diff --git a/doc/man/nvme_hmac_alg.2 b/doc/man/nvme_hmac_alg.2 index be6a07c..c10e4bf 100644 --- a/doc/man/nvme_hmac_alg.2 +++ b/doc/man/nvme_hmac_alg.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_hmac_alg" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_hmac_alg" "July 2022" "API Manual" LINUX .SH NAME enum nvme_hmac_alg \- HMAC algorithm .SH SYNOPSIS diff --git a/doc/man/nvme_host_behavior_support.2 b/doc/man/nvme_host_behavior_support.2 index c70a25d..51c836f 100644 --- a/doc/man/nvme_host_behavior_support.2 +++ b/doc/man/nvme_host_behavior_support.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_host_behavior_support" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_host_behavior_support" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_host_behavior_support \- +enum nvme_host_behavior_support \- Enable Advanced Command .SH SYNOPSIS enum nvme_host_behavior_support { .br diff --git a/doc/man/nvme_host_get_dhchap_key.2 b/doc/man/nvme_host_get_dhchap_key.2 index 06505a2..9c0bba4 100644 --- a/doc/man/nvme_host_get_dhchap_key.2 +++ b/doc/man/nvme_host_get_dhchap_key.2 @@ -1,4 +1,4 @@ -.TH "nvme_host_get_dhchap_key" 9 "nvme_host_get_dhchap_key" "April 2022" "libnvme API manual" LINUX +.TH "nvme_host_get_dhchap_key" 9 "nvme_host_get_dhchap_key" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_host_get_dhchap_key \- Return host key .SH SYNOPSIS diff --git a/doc/man/nvme_host_get_hostid.2 b/doc/man/nvme_host_get_hostid.2 index 6e34d5c..eada095 100644 --- a/doc/man/nvme_host_get_hostid.2 +++ b/doc/man/nvme_host_get_hostid.2 @@ -1,4 +1,4 @@ -.TH "nvme_host_get_hostid" 9 "nvme_host_get_hostid" "April 2022" "libnvme API manual" LINUX +.TH "nvme_host_get_hostid" 9 "nvme_host_get_hostid" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_host_get_hostid \- Host ID of an nvme_host_t object .SH SYNOPSIS diff --git a/doc/man/nvme_host_get_hostnqn.2 b/doc/man/nvme_host_get_hostnqn.2 index 24c44f2..bb4d41c 100644 --- a/doc/man/nvme_host_get_hostnqn.2 +++ b/doc/man/nvme_host_get_hostnqn.2 @@ -1,4 +1,4 @@ -.TH "nvme_host_get_hostnqn" 9 "nvme_host_get_hostnqn" "April 2022" "libnvme API manual" LINUX +.TH "nvme_host_get_hostnqn" 9 "nvme_host_get_hostnqn" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_host_get_hostnqn \- Host NQN of an nvme_host_t object .SH SYNOPSIS diff --git a/doc/man/nvme_host_get_hostsymname.2 b/doc/man/nvme_host_get_hostsymname.2 index 9232596..a172da8 100644 --- a/doc/man/nvme_host_get_hostsymname.2 +++ b/doc/man/nvme_host_get_hostsymname.2 @@ -1,4 +1,4 @@ -.TH "nvme_host_get_hostsymname" 9 "nvme_host_get_hostsymname" "April 2022" "libnvme API manual" LINUX +.TH "nvme_host_get_hostsymname" 9 "nvme_host_get_hostsymname" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_host_get_hostsymname \- Get the host's symbolic name .SH SYNOPSIS diff --git a/doc/man/nvme_host_get_root.2 b/doc/man/nvme_host_get_root.2 index e2c2f92..18174ae 100644 --- a/doc/man/nvme_host_get_root.2 +++ b/doc/man/nvme_host_get_root.2 @@ -1,4 +1,4 @@ -.TH "nvme_host_get_root" 9 "nvme_host_get_root" "April 2022" "libnvme API manual" LINUX +.TH "nvme_host_get_root" 9 "nvme_host_get_root" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_host_get_root \- Returns nvme_root_t object .SH SYNOPSIS diff --git a/doc/man/nvme_host_mem_buf_attrs.2 b/doc/man/nvme_host_mem_buf_attrs.2 index 83bd190..06f1ad2 100644 --- a/doc/man/nvme_host_mem_buf_attrs.2 +++ b/doc/man/nvme_host_mem_buf_attrs.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_host_mem_buf_attrs" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_host_mem_buf_attrs" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_host_mem_buf_attrs \- +struct nvme_host_mem_buf_attrs \- Host Memory Buffer - Attributes Data Structure .SH SYNOPSIS struct nvme_host_mem_buf_attrs { .br diff --git a/doc/man/nvme_host_metadata.2 b/doc/man/nvme_host_metadata.2 index beed508..a44b6bb 100644 --- a/doc/man/nvme_host_metadata.2 +++ b/doc/man/nvme_host_metadata.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_host_metadata" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_host_metadata" "July 2022" "API Manual" LINUX .SH NAME struct nvme_host_metadata \- Host Metadata Data Structure .SH SYNOPSIS diff --git a/doc/man/nvme_host_set_dhchap_key.2 b/doc/man/nvme_host_set_dhchap_key.2 index e7a7a1a..6a68157 100644 --- a/doc/man/nvme_host_set_dhchap_key.2 +++ b/doc/man/nvme_host_set_dhchap_key.2 @@ -1,4 +1,4 @@ -.TH "nvme_host_set_dhchap_key" 9 "nvme_host_set_dhchap_key" "April 2022" "libnvme API manual" LINUX +.TH "nvme_host_set_dhchap_key" 9 "nvme_host_set_dhchap_key" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_host_set_dhchap_key \- set host key .SH SYNOPSIS diff --git a/doc/man/nvme_host_set_hostsymname.2 b/doc/man/nvme_host_set_hostsymname.2 index 54c0b43..28778f1 100644 --- a/doc/man/nvme_host_set_hostsymname.2 +++ b/doc/man/nvme_host_set_hostsymname.2 @@ -1,4 +1,4 @@ -.TH "nvme_host_set_hostsymname" 9 "nvme_host_set_hostsymname" "April 2022" "libnvme API manual" LINUX +.TH "nvme_host_set_hostsymname" 9 "nvme_host_set_hostsymname" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_host_set_hostsymname \- Set the host's symbolic name .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl.2 b/doc/man/nvme_id_ctrl.2 index e42c4df..8035ec7 100644 --- a/doc/man/nvme_id_ctrl.2 +++ b/doc/man/nvme_id_ctrl.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_id_ctrl" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_ctrl" "July 2022" "API Manual" LINUX .SH NAME struct nvme_id_ctrl \- Identify Controller data structure .SH SYNOPSIS @@ -206,11 +206,11 @@ the PCI SIG. PCI Subsystem Vendor ID, the company vendor identifier that is assigned by the PCI SIG for the subsystem. .IP "sn" 12 -Serial Number in ascii +Serial Number in ASCII .IP "mn" 12 -Model Number in ascii +Model Number in ASCII .IP "fr" 12 -Firmware Revision in ascii, the currently active firmware +Firmware Revision in ASCII, the currently active firmware revision for the NVM subsystem .IP "rab" 12 Recommended Arbitration Burst, reported as a power of two @@ -252,13 +252,13 @@ Controller Type, see \fIenum nvme_id_ctrl_cntrltype\fP FRU GUID, a 128-bit value that is globally unique for a given Field Replaceable Unit .IP "crdt1" 12 -Controller Retry Delay time in 100 millisecod units if CQE CRD +Controller Retry Delay time in 100 millisecond units if CQE CRD field is 1 .IP "crdt2" 12 -Controller Retry Delay time in 100 millisecod units if CQE CRD +Controller Retry Delay time in 100 millisecond units if CQE CRD field is 2 .IP "crdt3" 12 -Controller Retry Delay time in 100 millisecod units if CQE CRD +Controller Retry Delay time in 100 millisecond units if CQE CRD field is 3 .IP "rsvd134" 12 Reserved @@ -463,7 +463,7 @@ Maximum Number of Allowed Namespaces indicates the maximum number of namespaces supported by the NVM subsystem. .IP "maxdna" 12 Maximum Domain Namespace Attachments indicates the maximum -of the sum of the numver of namespaces attached to each I/O +of the sum of the number of namespaces attached to each I/O controller in the Domain. .IP "maxcna" 12 Maximum I/O Controller Namespace Attachments indicates the diff --git a/doc/man/nvme_id_ctrl_anacap.2 b/doc/man/nvme_id_ctrl_anacap.2 index f5106b6..6e8cc1b 100644 --- a/doc/man/nvme_id_ctrl_anacap.2 +++ b/doc/man/nvme_id_ctrl_anacap.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_anacap" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_anacap" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_anacap \- This field indicates the capabilities associated with Asymmetric Namespace Access Reporting. .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl_apsta.2 b/doc/man/nvme_id_ctrl_apsta.2 index c0c62c2..2b5160f 100644 --- a/doc/man/nvme_id_ctrl_apsta.2 +++ b/doc/man/nvme_id_ctrl_apsta.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_apsta" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_apsta" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_apsta \- Flags indicating the attributes of the autonomous power state transition feature. .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl_avscc.2 b/doc/man/nvme_id_ctrl_avscc.2 index 8864a80..a876629 100644 --- a/doc/man/nvme_id_ctrl_avscc.2 +++ b/doc/man/nvme_id_ctrl_avscc.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_avscc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_avscc" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_avscc \- Flags indicating the configuration settings for Admin Vendor Specific command handling. .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl_cmic.2 b/doc/man/nvme_id_ctrl_cmic.2 index 1844dcd..60eb47c 100644 --- a/doc/man/nvme_id_ctrl_cmic.2 +++ b/doc/man/nvme_id_ctrl_cmic.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_cmic" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_cmic" "July 2022" "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 diff --git a/doc/man/nvme_id_ctrl_cntrltype.2 b/doc/man/nvme_id_ctrl_cntrltype.2 index 9b3e6d8..93c3f75 100644 --- a/doc/man/nvme_id_ctrl_cntrltype.2 +++ b/doc/man/nvme_id_ctrl_cntrltype.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_cntrltype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_cntrltype" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_cntrltype \- Controller types .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl_cqes.2 b/doc/man/nvme_id_ctrl_cqes.2 index d3914f0..fa176a8 100644 --- a/doc/man/nvme_id_ctrl_cqes.2 +++ b/doc/man/nvme_id_ctrl_cqes.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_cqes" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_cqes" "July 2022" "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 diff --git a/doc/man/nvme_id_ctrl_ctratt.2 b/doc/man/nvme_id_ctrl_ctratt.2 index 3ee3da9..1cf06f3 100644 --- a/doc/man/nvme_id_ctrl_ctratt.2 +++ b/doc/man/nvme_id_ctrl_ctratt.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_ctratt" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_ctratt" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_ctratt \- Controller attributes .SH SYNOPSIS @@ -95,7 +95,7 @@ Multi-Domain Subsystem supported .IP "NVME_CTRL_CTRATT_FIXED_CAP" 12 Fixed Capacity Management supported .IP "NVME_CTRL_CTRATT_VARIABLE_CAP" 12 -Variable Capacity Managment supported +Variable Capacity Management supported .IP "NVME_CTRL_CTRATT_DEL_ENDURANCE_GROUPS" 12 Delete Endurance Groups supported .IP "NVME_CTRL_CTRATT_DEL_NVM_SETS" 12 diff --git a/doc/man/nvme_id_ctrl_dctype.2 b/doc/man/nvme_id_ctrl_dctype.2 index 5548874..7b6136c 100644 --- a/doc/man/nvme_id_ctrl_dctype.2 +++ b/doc/man/nvme_id_ctrl_dctype.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_dctype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_dctype" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_dctype \- Discovery Controller types .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl_dsto.2 b/doc/man/nvme_id_ctrl_dsto.2 index 2ede49c..c372ed0 100644 --- a/doc/man/nvme_id_ctrl_dsto.2 +++ b/doc/man/nvme_id_ctrl_dsto.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_dsto" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_dsto" "July 2022" "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 diff --git a/doc/man/nvme_id_ctrl_fcatt.2 b/doc/man/nvme_id_ctrl_fcatt.2 index 2f15f13..0910ea6 100644 --- a/doc/man/nvme_id_ctrl_fcatt.2 +++ b/doc/man/nvme_id_ctrl_fcatt.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_fcatt" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_fcatt" "July 2022" "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 diff --git a/doc/man/nvme_id_ctrl_fna.2 b/doc/man/nvme_id_ctrl_fna.2 index 7b68f26..733b504 100644 --- a/doc/man/nvme_id_ctrl_fna.2 +++ b/doc/man/nvme_id_ctrl_fna.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_fna" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_fna" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_fna \- This field indicates attributes for the Format NVM command. .SH SYNOPSIS @@ -13,6 +13,10 @@ enum nvme_id_ctrl_fna { .br .br .BI " NVME_CTRL_FNA_CRYPTO_ERASE" +, +.br +.br +.BI " NVME_CTRL_FNA_NSID_FFFFFFFF" }; .SH Constants @@ -37,3 +41,8 @@ particular namespace specified. If set, then cryptographic erase is supported. If cleared, then cryptographic erase is not supported. +.IP "NVME_CTRL_FNA_NSID_FFFFFFFF" 12 +If set, then format does not support +nsid value set to FFFFFFFFh. If cleared, +format supports nsid value set to +FFFFFFFFh. diff --git a/doc/man/nvme_id_ctrl_frmw.2 b/doc/man/nvme_id_ctrl_frmw.2 index f9e6fb0..269c06e 100644 --- a/doc/man/nvme_id_ctrl_frmw.2 +++ b/doc/man/nvme_id_ctrl_frmw.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_frmw" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_frmw" "July 2022" "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 @@ -13,6 +13,10 @@ enum nvme_id_ctrl_frmw { .br .br .BI " NVME_CTRL_FRMW_FW_ACT_NO_RESET" +, +.br +.br +.BI " NVME_CTRL_FRMW_MP_UP_DETECTION" }; .SH Constants @@ -24,3 +28,7 @@ firmware slots that the controller supports. .IP "NVME_CTRL_FRMW_FW_ACT_NO_RESET" 12 If set, the controller supports firmware activation without a reset. +.IP "NVME_CTRL_FRMW_MP_UP_DETECTION" 12 +If set, the controller is able to detect +overlapping firmware/boot partition +image update. diff --git a/doc/man/nvme_id_ctrl_fuses.2 b/doc/man/nvme_id_ctrl_fuses.2 index 27634d4..9504726 100644 --- a/doc/man/nvme_id_ctrl_fuses.2 +++ b/doc/man/nvme_id_ctrl_fuses.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_fuses" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_fuses" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_fuses \- This field indicates the fused operations that the controller supports. .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl_hctm.2 b/doc/man/nvme_id_ctrl_hctm.2 index e6d11bf..0a608d6 100644 --- a/doc/man/nvme_id_ctrl_hctm.2 +++ b/doc/man/nvme_id_ctrl_hctm.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_hctm" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_hctm" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_hctm \- Flags indicate the attributes of the host controlled thermal management feature .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl_lpa.2 b/doc/man/nvme_id_ctrl_lpa.2 index 1b88b89..19f05bc 100644 --- a/doc/man/nvme_id_ctrl_lpa.2 +++ b/doc/man/nvme_id_ctrl_lpa.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_lpa" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_lpa" "July 2022" "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 @@ -21,11 +21,45 @@ enum nvme_id_ctrl_lpa { .br .br .BI " NVME_CTRL_LPA_PERSETENT_EVENT" +, +.br +.br +.BI " NVME_CTRL_LPA_LI0_LI5_LI12_LI13" +, +.br +.br +.BI " NVME_CTRL_LPA_DA4_TELEMETRY" }; .SH Constants .IP "NVME_CTRL_LPA_SMART_PER_NS" 12 +If set, controller supports SMART/Health log +page on a per namespace basis. .IP "NVME_CTRL_LPA_CMD_EFFECTS" 12 +If Set, the controller supports the commands +supported and effects log page. .IP "NVME_CTRL_LPA_EXTENDED" 12 +If set, the controller supports extended data +for log page command including extended number +of dwords and log page offset fields. .IP "NVME_CTRL_LPA_TELEMETRY" 12 +If set, the controller supports the telemetry +host-initiated and telemetry controller-initiated +log pages and sending telemetry log notices. .IP "NVME_CTRL_LPA_PERSETENT_EVENT" 12 +If set, the controller supports +persistent event log. +.IP "NVME_CTRL_LPA_LI0_LI5_LI12_LI13" 12 +If set, the controller supports +- log pages log page. +- returning scope of each command in +commands supported and effects log +page. +- feature identifiers supported and +effects log page. +- NVMe-MI commands supported and +effects log page. +.IP "NVME_CTRL_LPA_DA4_TELEMETRY" 12 +If set, the controller supports data +area 4 for telemetry host-initiated and +telemetry. diff --git a/doc/man/nvme_id_ctrl_mec.2 b/doc/man/nvme_id_ctrl_mec.2 index afa77b6..ab93584 100644 --- a/doc/man/nvme_id_ctrl_mec.2 +++ b/doc/man/nvme_id_ctrl_mec.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_mec" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_mec" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_id_ctrl_mec \- Flags indicatings the capabilities of the Management Endpoint in the Controller, &struct nvme_id_ctrl.mec. +enum nvme_id_ctrl_mec \- Flags indicating the capabilities of the Management Endpoint in the Controller, &struct nvme_id_ctrl.mec. .SH SYNOPSIS enum nvme_id_ctrl_mec { .br diff --git a/doc/man/nvme_id_ctrl_nvm.2 b/doc/man/nvme_id_ctrl_nvm.2 index 16554ff..abf8a14 100644 --- a/doc/man/nvme_id_ctrl_nvm.2 +++ b/doc/man/nvme_id_ctrl_nvm.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_ctrl_nvm" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_ctrl_nvm" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_ctrl_nvm \- +struct nvme_id_ctrl_nvm \- I/O Command Set Specific Identify Controller data structure .SH SYNOPSIS struct nvme_id_ctrl_nvm { .br diff --git a/doc/man/nvme_id_ctrl_nvmsr.2 b/doc/man/nvme_id_ctrl_nvmsr.2 index e0b118f..b09ca66 100644 --- a/doc/man/nvme_id_ctrl_nvmsr.2 +++ b/doc/man/nvme_id_ctrl_nvmsr.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_nvmsr" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_nvmsr" "July 2022" "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 diff --git a/doc/man/nvme_id_ctrl_nvscc.2 b/doc/man/nvme_id_ctrl_nvscc.2 index 077c6ef..e76ff9d 100644 --- a/doc/man/nvme_id_ctrl_nvscc.2 +++ b/doc/man/nvme_id_ctrl_nvscc.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_nvscc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_nvscc" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_nvscc \- This field indicates the configuration settings for NVM Vendor Specific command handling. .SH SYNOPSIS @@ -10,4 +10,4 @@ enum nvme_id_ctrl_nvscc { .SH Constants .IP "NVME_CTRL_NVSCC_FMT" 12 If set, all NVM Vendor Specific Commands use the -format format with NDT and NDM fields. +format with NDT and NDM fields. diff --git a/doc/man/nvme_id_ctrl_nwpc.2 b/doc/man/nvme_id_ctrl_nwpc.2 index 794afe2..a1d7d0b 100644 --- a/doc/man/nvme_id_ctrl_nwpc.2 +++ b/doc/man/nvme_id_ctrl_nwpc.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_nwpc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_nwpc" "July 2022" "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 diff --git a/doc/man/nvme_id_ctrl_oacs.2 b/doc/man/nvme_id_ctrl_oacs.2 index d5ae344..ceddde2 100644 --- a/doc/man/nvme_id_ctrl_oacs.2 +++ b/doc/man/nvme_id_ctrl_oacs.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_oacs" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_oacs" "July 2022" "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 @@ -41,6 +41,10 @@ enum nvme_id_ctrl_oacs { .br .br .BI " NVME_CTRL_OACS_LBA_STATUS" +, +.br +.br +.BI " NVME_CTRL_OACS_CMD_FEAT_LD" }; .SH Constants @@ -75,3 +79,6 @@ Doorbell Buffer Config command. .IP "NVME_CTRL_OACS_LBA_STATUS" 12 If set, then the controller supports the Get LBA Status capability. +.IP "NVME_CTRL_OACS_CMD_FEAT_LD" 12 +If set, then the controller supports the command +and feature lockdown capability. diff --git a/doc/man/nvme_id_ctrl_oaes.2 b/doc/man/nvme_id_ctrl_oaes.2 index 3e27733..7bc7be0 100644 --- a/doc/man/nvme_id_ctrl_oaes.2 +++ b/doc/man/nvme_id_ctrl_oaes.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_oaes" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_oaes" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_oaes \- Optional Asynchronous Events Supported .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl_ofcs.2 b/doc/man/nvme_id_ctrl_ofcs.2 index d03d025..b45fefc 100644 --- a/doc/man/nvme_id_ctrl_ofcs.2 +++ b/doc/man/nvme_id_ctrl_ofcs.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_ofcs" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_ofcs" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_ofcs \- Indicate whether the controller supports optional fabric commands. .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl_oncs.2 b/doc/man/nvme_id_ctrl_oncs.2 index fe711b7..a611619 100644 --- a/doc/man/nvme_id_ctrl_oncs.2 +++ b/doc/man/nvme_id_ctrl_oncs.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_oncs" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_oncs" "July 2022" "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 @@ -33,6 +33,10 @@ enum nvme_id_ctrl_oncs { .br .br .BI " NVME_CTRL_ONCS_VERIFY" +, +.br +.br +.BI " NVME_CTRL_ONCS_COPY" }; .SH Constants @@ -63,3 +67,6 @@ the Timestamp feature. .IP "NVME_CTRL_ONCS_VERIFY" 12 If set, then the controller supports the Verify command. +.IP "NVME_CTRL_ONCS_COPY" 12 +If set, then the controller supports +the copy command. diff --git a/doc/man/nvme_id_ctrl_rpmbs.2 b/doc/man/nvme_id_ctrl_rpmbs.2 index 95a861c..50f0da7 100644 --- a/doc/man/nvme_id_ctrl_rpmbs.2 +++ b/doc/man/nvme_id_ctrl_rpmbs.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_rpmbs" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_rpmbs" "July 2022" "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 diff --git a/doc/man/nvme_id_ctrl_sanicap.2 b/doc/man/nvme_id_ctrl_sanicap.2 index 1c09afc..5daebb6 100644 --- a/doc/man/nvme_id_ctrl_sanicap.2 +++ b/doc/man/nvme_id_ctrl_sanicap.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_sanicap" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_sanicap" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ctrl_sanicap \- Indicates attributes for sanitize operations. .SH SYNOPSIS diff --git a/doc/man/nvme_id_ctrl_sgls.2 b/doc/man/nvme_id_ctrl_sgls.2 index efe1ddd..bbca025 100644 --- a/doc/man/nvme_id_ctrl_sgls.2 +++ b/doc/man/nvme_id_ctrl_sgls.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_sgls" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_sgls" "July 2022" "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 diff --git a/doc/man/nvme_id_ctrl_sqes.2 b/doc/man/nvme_id_ctrl_sqes.2 index 4ed6fee..1ef0271 100644 --- a/doc/man/nvme_id_ctrl_sqes.2 +++ b/doc/man/nvme_id_ctrl_sqes.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_sqes" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_sqes" "July 2022" "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 diff --git a/doc/man/nvme_id_ctrl_vwc.2 b/doc/man/nvme_id_ctrl_vwc.2 index a020908..777a85c 100644 --- a/doc/man/nvme_id_ctrl_vwc.2 +++ b/doc/man/nvme_id_ctrl_vwc.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_vwc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_vwc" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_id_ctrl_vwc \- +enum nvme_id_ctrl_vwc \- Volatile write cache .SH SYNOPSIS enum nvme_id_ctrl_vwc { .br diff --git a/doc/man/nvme_id_ctrl_vwci.2 b/doc/man/nvme_id_ctrl_vwci.2 index 4600a2c..0d0646e 100644 --- a/doc/man/nvme_id_ctrl_vwci.2 +++ b/doc/man/nvme_id_ctrl_vwci.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ctrl_vwci" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ctrl_vwci" "July 2022" "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 diff --git a/doc/man/nvme_id_directives.2 b/doc/man/nvme_id_directives.2 index 29ef330..d79cdef 100644 --- a/doc/man/nvme_id_directives.2 +++ b/doc/man/nvme_id_directives.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_directives" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_directives" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_directives \- +struct nvme_id_directives \- Identify Directive - Return Parameters Data Structure .SH SYNOPSIS struct nvme_id_directives { .br diff --git a/doc/man/nvme_id_domain_attr.2 b/doc/man/nvme_id_domain_attr.2 index fe69d9a..417c159 100644 --- a/doc/man/nvme_id_domain_attr.2 +++ b/doc/man/nvme_id_domain_attr.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_id_domain_attr" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_domain_attr" "July 2022" "API Manual" LINUX .SH NAME struct nvme_id_domain_attr \- Domain Attributes Entry .SH SYNOPSIS diff --git a/doc/man/nvme_id_domain_list.2 b/doc/man/nvme_id_domain_list.2 index 413aab3..fb5c7be 100644 --- a/doc/man/nvme_id_domain_list.2 +++ b/doc/man/nvme_id_domain_list.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_domain_list" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_domain_list" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_domain_list \- +struct nvme_id_domain_list \- Domain List .SH SYNOPSIS struct nvme_id_domain_list { .br diff --git a/doc/man/nvme_id_endurance_group_list.2 b/doc/man/nvme_id_endurance_group_list.2 index 30db7cd..8f2aced 100644 --- a/doc/man/nvme_id_endurance_group_list.2 +++ b/doc/man/nvme_id_endurance_group_list.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_endurance_group_list" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_endurance_group_list" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_endurance_group_list \- +struct nvme_id_endurance_group_list \- Endurance Group List .SH SYNOPSIS struct nvme_id_endurance_group_list { .br diff --git a/doc/man/nvme_id_independent_id_ns.2 b/doc/man/nvme_id_independent_id_ns.2 index 03281e0..045639d 100644 --- a/doc/man/nvme_id_independent_id_ns.2 +++ b/doc/man/nvme_id_independent_id_ns.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_independent_id_ns" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_independent_id_ns" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_independent_id_ns \- +struct nvme_id_independent_id_ns \- Identify - I/O Command Set Independent Identify Namespace Data Structure .SH SYNOPSIS struct nvme_id_independent_id_ns { .br diff --git a/doc/man/nvme_id_iocs.2 b/doc/man/nvme_id_iocs.2 index 20606c9..c6b2405 100644 --- a/doc/man/nvme_id_iocs.2 +++ b/doc/man/nvme_id_iocs.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_id_iocs" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_iocs" "July 2022" "API Manual" LINUX .SH NAME struct nvme_id_iocs \- NVMe Identify IO Command Set data structure .SH SYNOPSIS diff --git a/doc/man/nvme_id_ns.2 b/doc/man/nvme_id_ns.2 index 9a82518..bdaf520 100644 --- a/doc/man/nvme_id_ns.2 +++ b/doc/man/nvme_id_ns.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_id_ns" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_ns" "July 2022" "API Manual" LINUX .SH NAME struct nvme_id_ns \- Identify Namespace data structure .SH SYNOPSIS diff --git a/doc/man/nvme_id_ns_attr.2 b/doc/man/nvme_id_ns_attr.2 index 05bd554..a6577f6 100644 --- a/doc/man/nvme_id_ns_attr.2 +++ b/doc/man/nvme_id_ns_attr.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ns_attr" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ns_attr" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ns_attr \- Specifies attributes of the namespace. .SH SYNOPSIS diff --git a/doc/man/nvme_id_ns_dlfeat.2 b/doc/man/nvme_id_ns_dlfeat.2 index 2dabf24..cb0e477 100644 --- a/doc/man/nvme_id_ns_dlfeat.2 +++ b/doc/man/nvme_id_ns_dlfeat.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ns_dlfeat" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ns_dlfeat" "July 2022" "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 diff --git a/doc/man/nvme_id_ns_dpc.2 b/doc/man/nvme_id_ns_dpc.2 index 2ccfca9..b0f076e 100644 --- a/doc/man/nvme_id_ns_dpc.2 +++ b/doc/man/nvme_id_ns_dpc.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ns_dpc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ns_dpc" "July 2022" "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 diff --git a/doc/man/nvme_id_ns_dps.2 b/doc/man/nvme_id_ns_dps.2 index f171054..62aecd9 100644 --- a/doc/man/nvme_id_ns_dps.2 +++ b/doc/man/nvme_id_ns_dps.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ns_dps" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ns_dps" "July 2022" "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 diff --git a/doc/man/nvme_id_ns_flbas.2 b/doc/man/nvme_id_ns_flbas.2 index e2b54af..39580b9 100644 --- a/doc/man/nvme_id_ns_flbas.2 +++ b/doc/man/nvme_id_ns_flbas.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ns_flbas" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ns_flbas" "July 2022" "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 diff --git a/doc/man/nvme_id_ns_granularity_desc.2 b/doc/man/nvme_id_ns_granularity_desc.2 index 8c7c259..fd5227c 100644 --- a/doc/man/nvme_id_ns_granularity_desc.2 +++ b/doc/man/nvme_id_ns_granularity_desc.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_ns_granularity_desc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_ns_granularity_desc" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_ns_granularity_desc \- +struct nvme_id_ns_granularity_desc \- Namespace Granularity Descriptor .SH SYNOPSIS struct nvme_id_ns_granularity_desc { .br diff --git a/doc/man/nvme_id_ns_granularity_list.2 b/doc/man/nvme_id_ns_granularity_list.2 index 375974e..210a866 100644 --- a/doc/man/nvme_id_ns_granularity_list.2 +++ b/doc/man/nvme_id_ns_granularity_list.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_ns_granularity_list" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_ns_granularity_list" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_ns_granularity_list \- +struct nvme_id_ns_granularity_list \- Namespace Granularity List .SH SYNOPSIS struct nvme_id_ns_granularity_list { .br diff --git a/doc/man/nvme_id_ns_mc.2 b/doc/man/nvme_id_ns_mc.2 index 774742f..6c72e92 100644 --- a/doc/man/nvme_id_ns_mc.2 +++ b/doc/man/nvme_id_ns_mc.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ns_mc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ns_mc" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ns_mc \- This field indicates the capabilities for metadata. .SH SYNOPSIS diff --git a/doc/man/nvme_id_ns_nmic.2 b/doc/man/nvme_id_ns_nmic.2 index 9f15b41..c9234ef 100644 --- a/doc/man/nvme_id_ns_nmic.2 +++ b/doc/man/nvme_id_ns_nmic.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ns_nmic" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ns_nmic" "July 2022" "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 diff --git a/doc/man/nvme_id_ns_rescap.2 b/doc/man/nvme_id_ns_rescap.2 index 63fc83e..d170da5 100644 --- a/doc/man/nvme_id_ns_rescap.2 +++ b/doc/man/nvme_id_ns_rescap.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_ns_rescap" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_ns_rescap" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_ns_rescap \- This field indicates the reservation capabilities of the namespace. .SH SYNOPSIS diff --git a/doc/man/nvme_id_nsfeat.2 b/doc/man/nvme_id_nsfeat.2 index 3c5c9ec..d242158 100644 --- a/doc/man/nvme_id_nsfeat.2 +++ b/doc/man/nvme_id_nsfeat.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_id_nsfeat" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_nsfeat" "July 2022" "API Manual" LINUX .SH NAME enum nvme_id_nsfeat \- This field defines features of the namespace. .SH SYNOPSIS diff --git a/doc/man/nvme_id_nvmset_list.2 b/doc/man/nvme_id_nvmset_list.2 index 6907ea7..473b32e 100644 --- a/doc/man/nvme_id_nvmset_list.2 +++ b/doc/man/nvme_id_nvmset_list.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_nvmset_list" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_nvmset_list" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_nvmset_list \- +struct nvme_id_nvmset_list \- NVM set list .SH SYNOPSIS struct nvme_id_nvmset_list { .br diff --git a/doc/man/nvme_id_psd.2 b/doc/man/nvme_id_psd.2 index 435d380..90d4817 100644 --- a/doc/man/nvme_id_psd.2 +++ b/doc/man/nvme_id_psd.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_psd" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_psd" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_psd \- +struct nvme_id_psd \- Power Management data structure .SH SYNOPSIS struct nvme_id_psd { .br @@ -62,7 +62,7 @@ Relative Read Throughput indicates the read throughput rank associated with this power state relative to others. The value in this is less than the number of supported power states. .IP "rrl" 12 -Relative Reade Latency indicates the read latency rank associated +Relative Read Latency indicates the read latency rank associated with this power state relative to others. The value in this field is less than the number of supported power states. .IP "rwt" 12 diff --git a/doc/man/nvme_id_uuid.2 b/doc/man/nvme_id_uuid.2 index 01326e7..a9f46f3 100644 --- a/doc/man/nvme_id_uuid.2 +++ b/doc/man/nvme_id_uuid.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_id_uuid" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_id_uuid" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_id_uuid \- +enum nvme_id_uuid \- Identifier Association .SH SYNOPSIS enum nvme_id_uuid { .br diff --git a/doc/man/nvme_id_uuid_list.2 b/doc/man/nvme_id_uuid_list.2 index 8aca721..ae3f52f 100644 --- a/doc/man/nvme_id_uuid_list.2 +++ b/doc/man/nvme_id_uuid_list.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_uuid_list" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_uuid_list" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_uuid_list \- +struct nvme_id_uuid_list \- UUID list .SH SYNOPSIS struct nvme_id_uuid_list { .br diff --git a/doc/man/nvme_id_uuid_list_entry.2 b/doc/man/nvme_id_uuid_list_entry.2 index ca2d528..6caba7c 100644 --- a/doc/man/nvme_id_uuid_list_entry.2 +++ b/doc/man/nvme_id_uuid_list_entry.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_id_uuid_list_entry" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_id_uuid_list_entry" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_id_uuid_list_entry \- +struct nvme_id_uuid_list_entry \- UUID List Entry .SH SYNOPSIS struct nvme_id_uuid_list_entry { .br diff --git a/doc/man/nvme_identify.2 b/doc/man/nvme_identify.2 index 527185e..68c7d6a 100644 --- a/doc/man/nvme_identify.2 +++ b/doc/man/nvme_identify.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify" 9 "nvme_identify" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify" 9 "nvme_identify" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify \- Send the NVMe Identify command .SH SYNOPSIS diff --git a/doc/man/nvme_identify_active_ns_list.2 b/doc/man/nvme_identify_active_ns_list.2 index 73eba7c..6fd246f 100644 --- a/doc/man/nvme_identify_active_ns_list.2 +++ b/doc/man/nvme_identify_active_ns_list.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_active_ns_list" 9 "nvme_identify_active_ns_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_active_ns_list" 9 "nvme_identify_active_ns_list" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_active_ns_list \- Retrieves active namespaces id list .SH SYNOPSIS @@ -10,7 +10,7 @@ nvme_identify_active_ns_list \- Retrieves active namespaces id list .IP "fd" 12 File descriptor of nvme device .IP "nsid" 12 -Return namespaces greater than this identifer +Return namespaces greater than this identifier .IP "list" 12 User space destination address to transfer the data .SH "DESCRIPTION" diff --git a/doc/man/nvme_identify_active_ns_list_csi.2 b/doc/man/nvme_identify_active_ns_list_csi.2 index 01c49a9..21de441 100644 --- a/doc/man/nvme_identify_active_ns_list_csi.2 +++ b/doc/man/nvme_identify_active_ns_list_csi.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_active_ns_list_csi" 9 "nvme_identify_active_ns_list_csi" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_active_ns_list_csi" 9 "nvme_identify_active_ns_list_csi" "July 2022" "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 diff --git a/doc/man/nvme_identify_allocated_ns.2 b/doc/man/nvme_identify_allocated_ns.2 index 3927da4..2067eb6 100644 --- a/doc/man/nvme_identify_allocated_ns.2 +++ b/doc/man/nvme_identify_allocated_ns.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_allocated_ns" 9 "nvme_identify_allocated_ns" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_allocated_ns" 9 "nvme_identify_allocated_ns" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_allocated_ns \- Same as nvme_identify_ns, but only for allocated namespaces .SH SYNOPSIS diff --git a/doc/man/nvme_identify_allocated_ns_list.2 b/doc/man/nvme_identify_allocated_ns_list.2 index 5aaf6fc..9e9275c 100644 --- a/doc/man/nvme_identify_allocated_ns_list.2 +++ b/doc/man/nvme_identify_allocated_ns_list.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_allocated_ns_list" 9 "nvme_identify_allocated_ns_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_allocated_ns_list" 9 "nvme_identify_allocated_ns_list" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_allocated_ns_list \- Retrieves allocated namespace id list .SH SYNOPSIS @@ -10,7 +10,7 @@ nvme_identify_allocated_ns_list \- Retrieves allocated namespace id list .IP "fd" 12 File descriptor of nvme device .IP "nsid" 12 -Return namespaces greater than this identifer +Return namespaces greater than this identifier .IP "list" 12 User space destination address to transfer the data .SH "DESCRIPTION" diff --git a/doc/man/nvme_identify_allocated_ns_list_csi.2 b/doc/man/nvme_identify_allocated_ns_list_csi.2 index 447be6c..de81d3e 100644 --- a/doc/man/nvme_identify_allocated_ns_list_csi.2 +++ b/doc/man/nvme_identify_allocated_ns_list_csi.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_allocated_ns_list_csi" 9 "nvme_identify_allocated_ns_list_csi" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_allocated_ns_list_csi" 9 "nvme_identify_allocated_ns_list_csi" "July 2022" "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 diff --git a/doc/man/nvme_identify_args.2 b/doc/man/nvme_identify_args.2 deleted file mode 100644 index 58b9667..0000000 --- a/doc/man/nvme_identify_args.2 +++ /dev/null @@ -1,55 +0,0 @@ -.TH "libnvme" 9 "struct nvme_identify_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_identify_args \- Arguments for the NVMe Identify command -.SH SYNOPSIS -struct nvme_identify_args { -.br -.BI " __u32 *result;" -.br -.BI " void *data;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " enum nvme_identify_cns cns;" -.br -.BI " enum nvme_csi csi;" -.br -.BI " __u32 nsid;" -.br -.BI " __u16 cntid;" -.br -.BI " __u16 cns_specific_id;" -.br -.BI " __u8 uuidx;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "data" 12 -User space destination address to transfer the data -.IP "args_size" 12 -Size of \fIstruct nvme_identify_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms (0 for default timeout) -.IP "cns" 12 -The Controller or Namespace structure, see \fIenum\fP nvme_identify_cns -.IP "csi" 12 -Command Set Identifier -.IP "nsid" 12 -Namespace identifier, if applicable -.IP "cntid" 12 -The Controller Identifier, if applicable -.IP "cns_specific_id" 12 -Identifier that is required for a particular CNS value -.IP "uuidx" 12 -UUID Index if controller supports this id selection method diff --git a/doc/man/nvme_identify_cns.2 b/doc/man/nvme_identify_cns.2 index 1b5b4f2..4c2c71c 100644 --- a/doc/man/nvme_identify_cns.2 +++ b/doc/man/nvme_identify_cns.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_identify_cns" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_identify_cns" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_identify_cns \- +enum nvme_identify_cns \- Identify - CNS Values .SH SYNOPSIS enum nvme_identify_cns { .br @@ -103,7 +103,7 @@ enum nvme_identify_cns { .IP "NVME_IDENTIFY_CNS_NS" 12 Identify Namespace data structure .IP "NVME_IDENTIFY_CNS_CTRL" 12 -Identify Controller data structur +Identify Controller data structure .IP "NVME_IDENTIFY_CNS_NS_ACTIVE_LIST" 12 Active Namespace ID list .IP "NVME_IDENTIFY_CNS_NS_DESC_LIST" 12 @@ -121,11 +121,12 @@ Active Namespace ID list associated with the specified I/O Command Set .IP "NVME_IDENTIFY_CNS_CSI_INDEPENDENT_ID_NS" 12 I/O Command Set Independent Identify -Namespace data structure .IP "NVME_IDENTIFY_CNS_NS_USER_DATA_FORMAT" 12 --- undescribed -- +Namespace user data format .IP "NVME_IDENTIFY_CNS_CSI_NS_USER_DATA_FORMAT" 12 --- undescribed -- +I/O Command Set specific user data +format +Namespace data structure .IP "NVME_IDENTIFY_CNS_ALLOCATED_NS_LIST" 12 Allocated Namespace ID list .IP "NVME_IDENTIFY_CNS_ALLOCATED_NS" 12 @@ -145,7 +146,7 @@ Secondary Controller list of controllers associated with the primary controller processing the command .IP "NVME_IDENTIFY_CNS_NS_GRANULARITY" 12 -A Namespace Granularity Lis +A Namespace Granularity List .IP "NVME_IDENTIFY_CNS_UUID_LIST" 12 A UUID List .IP "NVME_IDENTIFY_CNS_DOMAIN_LIST" 12 diff --git a/doc/man/nvme_identify_ctrl.2 b/doc/man/nvme_identify_ctrl.2 index dce2bf1..79a0b40 100644 --- a/doc/man/nvme_identify_ctrl.2 +++ b/doc/man/nvme_identify_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_ctrl" 9 "nvme_identify_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_ctrl" 9 "nvme_identify_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_ctrl \- Retrieves nvme identify controller .SH SYNOPSIS diff --git a/doc/man/nvme_identify_ctrl_csi.2 b/doc/man/nvme_identify_ctrl_csi.2 index 60572eb..f8916e8 100644 --- a/doc/man/nvme_identify_ctrl_csi.2 +++ b/doc/man/nvme_identify_ctrl_csi.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_ctrl_csi" 9 "nvme_identify_ctrl_csi" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_ctrl_csi" 9 "nvme_identify_ctrl_csi" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_ctrl_csi \- I/O command set specific Identify Controller data .SH SYNOPSIS diff --git a/doc/man/nvme_identify_ctrl_list.2 b/doc/man/nvme_identify_ctrl_list.2 index dc2296f..14304f1 100644 --- a/doc/man/nvme_identify_ctrl_list.2 +++ b/doc/man/nvme_identify_ctrl_list.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_ctrl_list" 9 "nvme_identify_ctrl_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_ctrl_list" 9 "nvme_identify_ctrl_list" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_ctrl_list \- Retrieves identify controller list .SH SYNOPSIS diff --git a/doc/man/nvme_identify_domain_list.2 b/doc/man/nvme_identify_domain_list.2 index 58a76d8..8fd81c0 100644 --- a/doc/man/nvme_identify_domain_list.2 +++ b/doc/man/nvme_identify_domain_list.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_domain_list" 9 "nvme_identify_domain_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_domain_list" 9 "nvme_identify_domain_list" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_domain_list \- Domain list data .SH SYNOPSIS @@ -12,7 +12,7 @@ File descriptor of nvme device .IP "domid" 12 Domain ID .IP "list" 12 -User space destiantion address to transfer data +User space destination address to transfer data .SH "DESCRIPTION" A list of 31 domain IDs is returned to the host containing domain attributes in increasing order that are greater than the value diff --git a/doc/man/nvme_identify_endurance_group_list.2 b/doc/man/nvme_identify_endurance_group_list.2 index 5050a9e..d1e1676 100644 --- a/doc/man/nvme_identify_endurance_group_list.2 +++ b/doc/man/nvme_identify_endurance_group_list.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_endurance_group_list" 9 "nvme_identify_endurance_group_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_endurance_group_list" 9 "nvme_identify_endurance_group_list" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_endurance_group_list \- Endurance group list data .SH SYNOPSIS diff --git a/doc/man/nvme_identify_independent_identify_ns.2 b/doc/man/nvme_identify_independent_identify_ns.2 index 9dc83a0..e38cfa7 100644 --- a/doc/man/nvme_identify_independent_identify_ns.2 +++ b/doc/man/nvme_identify_independent_identify_ns.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_independent_identify_ns" 9 "nvme_identify_independent_identify_ns" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_independent_identify_ns" 9 "nvme_identify_independent_identify_ns" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_independent_identify_ns \- I/O command set independent Identify namespace data .SH SYNOPSIS diff --git a/doc/man/nvme_identify_iocs.2 b/doc/man/nvme_identify_iocs.2 index 5255ae4..d607793 100644 --- a/doc/man/nvme_identify_iocs.2 +++ b/doc/man/nvme_identify_iocs.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_iocs" 9 "nvme_identify_iocs" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_iocs" 9 "nvme_identify_iocs" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_iocs \- I/O command set data structure .SH SYNOPSIS diff --git a/doc/man/nvme_identify_iocs_ns_csi_user_data_format.2 b/doc/man/nvme_identify_iocs_ns_csi_user_data_format.2 index 86e1c21..9e99b0a 100644 --- a/doc/man/nvme_identify_iocs_ns_csi_user_data_format.2 +++ b/doc/man/nvme_identify_iocs_ns_csi_user_data_format.2 @@ -1,6 +1,6 @@ -.TH "nvme_identify_iocs_ns_csi_user_data_format" 9 "nvme_identify_iocs_ns_csi_user_data_format" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_iocs_ns_csi_user_data_format" 9 "nvme_identify_iocs_ns_csi_user_data_format" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_identify_iocs_ns_csi_user_data_format \- +nvme_identify_iocs_ns_csi_user_data_format \- Identify I/O command set namespace data structure .SH SYNOPSIS .B "int" nvme_identify_iocs_ns_csi_user_data_format .BI "(int fd " "," @@ -18,7 +18,7 @@ UUID selection, if supported .IP "csi" 12 Command Set Identifier .IP "data" 12 --- undescribed -- +User space destination address to transfer the data .SH "DESCRIPTION" I/O Command Set specific Identify Namespace data structure for the specified User Data Format index containing the namespace diff --git a/doc/man/nvme_identify_ns.2 b/doc/man/nvme_identify_ns.2 index 428c9cb..c731ee8 100644 --- a/doc/man/nvme_identify_ns.2 +++ b/doc/man/nvme_identify_ns.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_ns" 9 "nvme_identify_ns" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_ns" 9 "nvme_identify_ns" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_ns \- Retrieves nvme identify namespace .SH SYNOPSIS diff --git a/doc/man/nvme_identify_ns_csi.2 b/doc/man/nvme_identify_ns_csi.2 index f8ccf78..957ae6d 100644 --- a/doc/man/nvme_identify_ns_csi.2 +++ b/doc/man/nvme_identify_ns_csi.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_ns_csi" 9 "nvme_identify_ns_csi" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_ns_csi" 9 "nvme_identify_ns_csi" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_ns_csi \- I/O command set specific identify namespace data .SH SYNOPSIS @@ -20,7 +20,7 @@ Command Set Identifier .IP "data" 12 User space destination address to transfer the data .SH "DESCRIPTION" -An I/O Command Set specific Identify Namespace data structre is returned +An I/O Command Set specific Identify Namespace data structure is returned for the namespace specified in \fInsid\fP. .SH "RETURN" The nvme command status if a response was received (see diff --git a/doc/man/nvme_identify_ns_csi_user_data_format.2 b/doc/man/nvme_identify_ns_csi_user_data_format.2 index 96fa09c..d57d74c 100644 --- a/doc/man/nvme_identify_ns_csi_user_data_format.2 +++ b/doc/man/nvme_identify_ns_csi_user_data_format.2 @@ -1,6 +1,6 @@ -.TH "nvme_identify_ns_csi_user_data_format" 9 "nvme_identify_ns_csi_user_data_format" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_ns_csi_user_data_format" 9 "nvme_identify_ns_csi_user_data_format" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_identify_ns_csi_user_data_format \- +nvme_identify_ns_csi_user_data_format \- Identify namespace user data format .SH SYNOPSIS .B "int" nvme_identify_ns_csi_user_data_format .BI "(int fd " "," @@ -18,7 +18,7 @@ UUID selection, if supported .IP "csi" 12 Command Set Identifier .IP "data" 12 --- undescribed -- +User space destination address to transfer the data .SH "DESCRIPTION" Identify Namespace data structure for the specified User Data Format index containing the namespace capabilities for the NVM Command Set. diff --git a/doc/man/nvme_identify_ns_descs.2 b/doc/man/nvme_identify_ns_descs.2 index def86ee..479cb2c 100644 --- a/doc/man/nvme_identify_ns_descs.2 +++ b/doc/man/nvme_identify_ns_descs.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_ns_descs" 9 "nvme_identify_ns_descs" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_ns_descs" 9 "nvme_identify_ns_descs" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_ns_descs \- Retrieves namespace descriptor list .SH SYNOPSIS @@ -10,7 +10,7 @@ nvme_identify_ns_descs \- Retrieves namespace descriptor list .IP "fd" 12 File descriptor of nvme device .IP "nsid" 12 -The namespace id to retrieve destriptors +The namespace id to retrieve descriptors .IP "descs" 12 User space destination address to transfer the data .SH "DESCRIPTION" @@ -18,7 +18,7 @@ A list of Namespace Identification Descriptor structures is returned to the host for the namespace specified in the Namespace Identifier (NSID) field if it is an active NSID. -The data returned is in the form of an arrray of 'struct nvme_ns_id_desc'. +The data returned is in the form of an array of 'struct nvme_ns_id_desc'. See \fIstruct nvme_ns_id_desc\fP for the definition of the returned structure. .SH "RETURN" diff --git a/doc/man/nvme_identify_ns_granularity.2 b/doc/man/nvme_identify_ns_granularity.2 index f960461..b5102d8 100644 --- a/doc/man/nvme_identify_ns_granularity.2 +++ b/doc/man/nvme_identify_ns_granularity.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_ns_granularity" 9 "nvme_identify_ns_granularity" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_ns_granularity" 9 "nvme_identify_ns_granularity" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_ns_granularity \- Retrieves namespace granularity identification .SH SYNOPSIS diff --git a/doc/man/nvme_identify_nsid_ctrl_list.2 b/doc/man/nvme_identify_nsid_ctrl_list.2 index 3842e70..78530a2 100644 --- a/doc/man/nvme_identify_nsid_ctrl_list.2 +++ b/doc/man/nvme_identify_nsid_ctrl_list.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_nsid_ctrl_list" 9 "nvme_identify_nsid_ctrl_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_nsid_ctrl_list" 9 "nvme_identify_nsid_ctrl_list" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_nsid_ctrl_list \- Retrieves controller list attached to an nsid .SH SYNOPSIS diff --git a/doc/man/nvme_identify_nvmset_list.2 b/doc/man/nvme_identify_nvmset_list.2 index 98b368a..7862237 100644 --- a/doc/man/nvme_identify_nvmset_list.2 +++ b/doc/man/nvme_identify_nvmset_list.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_nvmset_list" 9 "nvme_identify_nvmset_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_nvmset_list" 9 "nvme_identify_nvmset_list" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_nvmset_list \- Retrieves NVM Set List .SH SYNOPSIS @@ -19,7 +19,7 @@ is an ordered list by NVM Set Identifier, starting with the first NVM Set Identifier supported by the NVM subsystem that is equal to or greater than the NVM Set Identifier. -See \fIstruct nvme_id_nvmset_list\fP for the defintion of the returned structure. +See \fIstruct nvme_id_nvmset_list\fP for the definition of the returned structure. .SH "RETURN" The nvme command status if a response was received (see \fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_primary_ctrl.2 b/doc/man/nvme_identify_primary_ctrl.2 index 8654539..8d3ec66 100644 --- a/doc/man/nvme_identify_primary_ctrl.2 +++ b/doc/man/nvme_identify_primary_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_primary_ctrl" 9 "nvme_identify_primary_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_primary_ctrl" 9 "nvme_identify_primary_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_primary_ctrl \- Retrieve NVMe Primary Controller identification .SH SYNOPSIS @@ -14,7 +14,7 @@ Return controllers starting at this identifier .IP "cap" 12 User space destination buffer address to transfer the data .SH "DESCRIPTION" -See \fIstruct nvme_primary_ctrl_cap\fP for the defintion of the returned structure, \fIcap\fP. +See \fIstruct nvme_primary_ctrl_cap\fP for the definition of the returned structure, \fIcap\fP. .SH "RETURN" The nvme command status if a response was received (see \fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_identify_secondary_ctrl_list.2 b/doc/man/nvme_identify_secondary_ctrl_list.2 index 7a81cce..4fa2548 100644 --- a/doc/man/nvme_identify_secondary_ctrl_list.2 +++ b/doc/man/nvme_identify_secondary_ctrl_list.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_secondary_ctrl_list" 9 "nvme_identify_secondary_ctrl_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_secondary_ctrl_list" 9 "nvme_identify_secondary_ctrl_list" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_secondary_ctrl_list \- Retrieves secondary controller list .SH SYNOPSIS @@ -22,7 +22,7 @@ controllers associated with the primary controller processing this command. The list contains entries for controller identifiers greater than or equal to the value specified in the Controller Identifier (cntid). -See \fIstruct nvme_secondary_ctrls_list\fP for a defintion of the returned +See \fIstruct nvme_secondary_ctrls_list\fP for a definition of the returned structure. .SH "RETURN" The nvme command status if a response was received (see diff --git a/doc/man/nvme_identify_uuid.2 b/doc/man/nvme_identify_uuid.2 index dc19985..c3ee0a8 100644 --- a/doc/man/nvme_identify_uuid.2 +++ b/doc/man/nvme_identify_uuid.2 @@ -1,4 +1,4 @@ -.TH "nvme_identify_uuid" 9 "nvme_identify_uuid" "April 2022" "libnvme API manual" LINUX +.TH "nvme_identify_uuid" 9 "nvme_identify_uuid" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_identify_uuid \- Retrieves device's UUIDs .SH SYNOPSIS diff --git a/doc/man/nvme_init_copy_range.2 b/doc/man/nvme_init_copy_range.2 index b49dd53..9850064 100644 --- a/doc/man/nvme_init_copy_range.2 +++ b/doc/man/nvme_init_copy_range.2 @@ -1,4 +1,4 @@ -.TH "nvme_init_copy_range" 9 "nvme_init_copy_range" "April 2022" "libnvme API manual" LINUX +.TH "nvme_init_copy_range" 9 "nvme_init_copy_range" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_init_copy_range \- Constructs a copy range structure .SH SYNOPSIS diff --git a/doc/man/nvme_init_ctrl.2 b/doc/man/nvme_init_ctrl.2 index 1799484..e5b655f 100644 --- a/doc/man/nvme_init_ctrl.2 +++ b/doc/man/nvme_init_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_init_ctrl" 9 "nvme_init_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_init_ctrl" 9 "nvme_init_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_init_ctrl \- Initialize nvme_ctrl_t object for an existing controller. .SH SYNOPSIS diff --git a/doc/man/nvme_init_ctrl_list.2 b/doc/man/nvme_init_ctrl_list.2 index 3173143..90e7c39 100644 --- a/doc/man/nvme_init_ctrl_list.2 +++ b/doc/man/nvme_init_ctrl_list.2 @@ -1,4 +1,4 @@ -.TH "nvme_init_ctrl_list" 9 "nvme_init_ctrl_list" "April 2022" "libnvme API manual" LINUX +.TH "nvme_init_ctrl_list" 9 "nvme_init_ctrl_list" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_init_ctrl_list \- Initialize an nvme_ctrl_list structure from an array. .SH SYNOPSIS diff --git a/doc/man/nvme_init_dsm_range.2 b/doc/man/nvme_init_dsm_range.2 index 260169d..c41c5c7 100644 --- a/doc/man/nvme_init_dsm_range.2 +++ b/doc/man/nvme_init_dsm_range.2 @@ -1,4 +1,4 @@ -.TH "nvme_init_dsm_range" 9 "nvme_init_dsm_range" "April 2022" "libnvme API manual" LINUX +.TH "nvme_init_dsm_range" 9 "nvme_init_dsm_range" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_init_dsm_range \- Constructs a data set range structure .SH SYNOPSIS diff --git a/doc/man/nvme_init_logging.2 b/doc/man/nvme_init_logging.2 index d2c2829..176428f 100644 --- a/doc/man/nvme_init_logging.2 +++ b/doc/man/nvme_init_logging.2 @@ -1,4 +1,4 @@ -.TH "nvme_init_logging" 9 "nvme_init_logging" "April 2022" "libnvme API manual" LINUX +.TH "nvme_init_logging" 9 "nvme_init_logging" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_init_logging \- Initialize logging .SH SYNOPSIS diff --git a/doc/man/nvme_io.2 b/doc/man/nvme_io.2 index 422b922..76feebf 100644 --- a/doc/man/nvme_io.2 +++ b/doc/man/nvme_io.2 @@ -1,4 +1,4 @@ -.TH "nvme_io" 9 "nvme_io" "April 2022" "libnvme API manual" LINUX +.TH "nvme_io" 9 "nvme_io" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_io \- Submit an nvme user I/O command .SH SYNOPSIS diff --git a/doc/man/nvme_io_args.2 b/doc/man/nvme_io_args.2 deleted file mode 100644 index 4993da8..0000000 --- a/doc/man/nvme_io_args.2 +++ /dev/null @@ -1,91 +0,0 @@ -.TH "libnvme" 9 "struct nvme_io_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_io_args \- Arguments for NVMe I/O commands -.SH SYNOPSIS -struct nvme_io_args { -.br -.BI " __u64 slba;" -.br -.BI " __u64 storage_tag;" -.br -.BI " __u32 *result;" -.br -.BI " void *data;" -.br -.BI " void *metadata;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " __u32 nsid;" -.br -.BI " __u32 reftag;" -.br -.BI " __u32 data_len;" -.br -.BI " __u32 metadata_len;" -.br -.BI " __u16 nlb;" -.br -.BI " __u16 control;" -.br -.BI " __u16 apptag;" -.br -.BI " __u16 appmask;" -.br -.BI " __u16 dspec;" -.br -.BI " __u8 dsm;" -.br -.BI " -}; -.br - -.SH Members -.IP "slba" 12 -Starting logical block -.IP "storage_tag" 12 -This filed specifies Variable Sized Expected Logical Block -Storage Tag (ELBST) and Expected Logical Block Reference -Tag (ELBRT) -.IP "result" 12 -The command completion result from CQE dword0 -.IP "data" 12 -Pointer to user address of the data buffer -.IP "metadata" 12 -Pointer to user address of the metadata buffer -.IP "args_size" 12 -Size of \fIstruct nvme_io_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace ID -.IP "reftag" 12 -This field specifies the Initial Logical Block Reference Tag -expected value. Used only if the namespace is formatted to use -end-to-end protection information. -.IP "data_len" 12 -Length of user buffer, \fIdata\fP, in bytes -.IP "metadata_len" 12 -Length of user buffer, \fImetadata\fP, in bytes -.IP "nlb" 12 -Number of logical blocks to send (0's based value) -.IP "control" 12 -Command control flags, see \fIenum nvme_io_control_flags\fP. -.IP "apptag" 12 -This field specifies the Application Tag Mask expected value. -Used only if the namespace is formatted to use end-to-end -protection information. -.IP "appmask" 12 -This field specifies the Application Tag expected value. Used -only if the namespace is formatted to use end-to-end protection -information. -.IP "dspec" 12 -Directive specific value -.IP "dsm" 12 -Data set management attributes, see \fIenum nvme_io_dsm_flags\fP diff --git a/doc/man/nvme_io_control_flags.2 b/doc/man/nvme_io_control_flags.2 index 43ee21f..b6ef904 100644 --- a/doc/man/nvme_io_control_flags.2 +++ b/doc/man/nvme_io_control_flags.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_io_control_flags" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_io_control_flags" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_io_control_flags \- +enum nvme_io_control_flags \- I/O control flags .SH SYNOPSIS enum nvme_io_control_flags { .br @@ -8,6 +8,10 @@ enum nvme_io_control_flags { , .br .br +.BI " NVME_IO_STC" +, +.br +.br .BI " NVME_IO_DEAC" , .br @@ -42,6 +46,8 @@ enum nvme_io_control_flags { .SH Constants .IP "NVME_IO_DTYPE_STREAMS" 12 Directive Type Streams +.IP "NVME_IO_STC" 12 +Storage Tag Check .IP "NVME_IO_DEAC" 12 Deallocate .IP "NVME_IO_ZNS_APPEND_PIREMAP" 12 diff --git a/doc/man/nvme_io_dsm_flags.2 b/doc/man/nvme_io_dsm_flags.2 index 5daacc3..1d97550 100644 --- a/doc/man/nvme_io_dsm_flags.2 +++ b/doc/man/nvme_io_dsm_flags.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_io_dsm_flags" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_io_dsm_flags" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_io_dsm_flags \- +enum nvme_io_dsm_flags \- Dataset Management flags .SH SYNOPSIS enum nvme_io_dsm_flags { .br diff --git a/doc/man/nvme_io_opcode.2 b/doc/man/nvme_io_opcode.2 index 74fd864..c3a2f32 100644 --- a/doc/man/nvme_io_opcode.2 +++ b/doc/man/nvme_io_opcode.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_io_opcode" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_io_opcode" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_io_opcode \- +enum nvme_io_opcode \- Opcodes for I/O Commands .SH SYNOPSIS enum nvme_io_opcode { .br diff --git a/doc/man/nvme_io_passthru.2 b/doc/man/nvme_io_passthru.2 index 0e848ea..54ea04c 100644 --- a/doc/man/nvme_io_passthru.2 +++ b/doc/man/nvme_io_passthru.2 @@ -1,4 +1,4 @@ -.TH "nvme_io_passthru" 9 "nvme_io_passthru" "April 2022" "libnvme API manual" LINUX +.TH "nvme_io_passthru" 9 "nvme_io_passthru" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_io_passthru \- Submit an nvme io 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 diff --git a/doc/man/nvme_lba_range_type.2 b/doc/man/nvme_lba_range_type.2 index 14caf22..9e644df 100644 --- a/doc/man/nvme_lba_range_type.2 +++ b/doc/man/nvme_lba_range_type.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_lba_range_type" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_lba_range_type" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_lba_range_type \- +struct nvme_lba_range_type \- LBA Range Type .SH SYNOPSIS struct nvme_lba_range_type { .br @@ -12,4 +12,4 @@ struct nvme_lba_range_type { .SH Members .IP "entry" 12 -LBA range type entry +LBA range type entry. See \fIstruct\fP nvme_lba_range_type_entry diff --git a/doc/man/nvme_lba_range_type_entry.2 b/doc/man/nvme_lba_range_type_entry.2 index ef9496b..0b9fddc 100644 --- a/doc/man/nvme_lba_range_type_entry.2 +++ b/doc/man/nvme_lba_range_type_entry.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_lba_range_type_entry" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_lba_range_type_entry" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_lba_range_type_entry \- +struct nvme_lba_range_type_entry \- LBA Range Type - Data Structure Entry .SH SYNOPSIS struct nvme_lba_range_type_entry { .br diff --git a/doc/man/nvme_lba_rd.2 b/doc/man/nvme_lba_rd.2 index 5203f90..76528ad 100644 --- a/doc/man/nvme_lba_rd.2 +++ b/doc/man/nvme_lba_rd.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_lba_rd" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_lba_rd" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_lba_rd \- +struct nvme_lba_rd \- LBA Range Descriptor .SH SYNOPSIS struct nvme_lba_rd { .br diff --git a/doc/man/nvme_lba_status.2 b/doc/man/nvme_lba_status.2 index c4b55f5..d76246a 100644 --- a/doc/man/nvme_lba_status.2 +++ b/doc/man/nvme_lba_status.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_lba_status" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_lba_status" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_lba_status \- +struct nvme_lba_status \- LBA Status Descriptor List .SH SYNOPSIS struct nvme_lba_status { .br diff --git a/doc/man/nvme_lba_status_atype.2 b/doc/man/nvme_lba_status_atype.2 index 4cc9aa6..b4d7ac3 100644 --- a/doc/man/nvme_lba_status_atype.2 +++ b/doc/man/nvme_lba_status_atype.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_lba_status_atype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_lba_status_atype" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_lba_status_atype \- +enum nvme_lba_status_atype \- Potentially Unrecoverable LBAs .SH SYNOPSIS enum nvme_lba_status_atype { .br @@ -13,4 +13,7 @@ enum nvme_lba_status_atype { }; .SH Constants .IP "NVME_LBA_STATUS_ATYPE_SCAN_UNTRACKED" 12 +Potentially Unrecoverable LBAs .IP "NVME_LBA_STATUS_ATYPE_SCAN_TRACKED" 12 +Potentially Unrecoverable LBAs +associated with physical storage diff --git a/doc/man/nvme_lba_status_desc.2 b/doc/man/nvme_lba_status_desc.2 index c1d8309..5c0ef71 100644 --- a/doc/man/nvme_lba_status_desc.2 +++ b/doc/man/nvme_lba_status_desc.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_lba_status_desc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_lba_status_desc" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_lba_status_desc \- +struct nvme_lba_status_desc \- LBA Status Descriptor Entry .SH SYNOPSIS struct nvme_lba_status_desc { .br diff --git a/doc/man/nvme_lba_status_log.2 b/doc/man/nvme_lba_status_log.2 index 6574def..7593f30 100644 --- a/doc/man/nvme_lba_status_log.2 +++ b/doc/man/nvme_lba_status_log.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_lba_status_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_lba_status_log" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_lba_status_log \- +struct nvme_lba_status_log \- LBA Status Information Log .SH SYNOPSIS struct nvme_lba_status_log { .br diff --git a/doc/man/nvme_lbaf.2 b/doc/man/nvme_lbaf.2 index 2270b8b..4e59a2f 100644 --- a/doc/man/nvme_lbaf.2 +++ b/doc/man/nvme_lbaf.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_lbaf" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_lbaf" "July 2022" "API Manual" LINUX .SH NAME struct nvme_lbaf \- LBA Format Data Structure .SH SYNOPSIS diff --git a/doc/man/nvme_lbaf_rp.2 b/doc/man/nvme_lbaf_rp.2 index 37d9ab6..3b5cc51 100644 --- a/doc/man/nvme_lbaf_rp.2 +++ b/doc/man/nvme_lbaf_rp.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_lbaf_rp" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_lbaf_rp" "July 2022" "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 diff --git a/doc/man/nvme_lbart.2 b/doc/man/nvme_lbart.2 index 6c1ee8a..aeea9c4 100644 --- a/doc/man/nvme_lbart.2 +++ b/doc/man/nvme_lbart.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_lbart" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_lbart" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_lbart \- +enum nvme_lbart \- LBA Range Type - Data Structure Entry .SH SYNOPSIS enum nvme_lbart { .br diff --git a/doc/man/nvme_lbas_ns_element.2 b/doc/man/nvme_lbas_ns_element.2 index 5367ae1..7d8ffe7 100644 --- a/doc/man/nvme_lbas_ns_element.2 +++ b/doc/man/nvme_lbas_ns_element.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_lbas_ns_element" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_lbas_ns_element" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_lbas_ns_element \- +struct nvme_lbas_ns_element \- LBA Status Log Namespace Element .SH SYNOPSIS struct nvme_lbas_ns_element { .br @@ -24,7 +24,7 @@ Namespace Element Identifier .IP "nlrd" 12 Number of LBA Range Descriptors .IP "ratype" 12 -Recommended Action Type +Recommended Action Type. see \fIenum\fP nvme_lba_status_atype .IP "rsvd8" 12 Reserved .IP "lba_rd" 12 diff --git a/doc/man/nvme_lockdown.2 b/doc/man/nvme_lockdown.2 index dd67871..3ce5be9 100644 --- a/doc/man/nvme_lockdown.2 +++ b/doc/man/nvme_lockdown.2 @@ -1,4 +1,4 @@ -.TH "nvme_lockdown" 9 "nvme_lockdown" "April 2022" "libnvme API manual" LINUX +.TH "nvme_lockdown" 9 "nvme_lockdown" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_lockdown \- Issue lockdown command .SH SYNOPSIS diff --git a/doc/man/nvme_lockdown_args.2 b/doc/man/nvme_lockdown_args.2 deleted file mode 100644 index c8f83b5..0000000 --- a/doc/man/nvme_lockdown_args.2 +++ /dev/null @@ -1,47 +0,0 @@ -.TH "libnvme" 9 "struct nvme_lockdown_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_lockdown_args \- Arguments for the NVME Lockdown command -.SH SYNOPSIS -struct nvme_lockdown_args { -.br -.BI " __u32 *result;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " __u8 scp;" -.br -.BI " __u8 prhbt;" -.br -.BI " __u8 ifc;" -.br -.BI " __u8 ofi;" -.br -.BI " __u8 uuidx;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "args_size" 12 -Size of \fIstruct nvme_lockdown_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms (0 for default timeout) -.IP "scp" 12 -Scope of the command -.IP "prhbt" 12 -Prohibit or allow the command opcode or Set Features command -.IP "ifc" 12 -Affected interface -.IP "ofi" 12 -Opcode or Feature Identifier -.IP "uuidx" 12 -UUID Index if controller supports this id selection method diff --git a/doc/man/nvme_log_ana_lsp.2 b/doc/man/nvme_log_ana_lsp.2 index fc8f063..b04e8bf 100644 --- a/doc/man/nvme_log_ana_lsp.2 +++ b/doc/man/nvme_log_ana_lsp.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_log_ana_lsp" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_log_ana_lsp" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_log_ana_lsp \- +enum nvme_log_ana_lsp \- Asymmetric Namespace Access - Return Groups Only .SH SYNOPSIS enum nvme_log_ana_lsp { .br diff --git a/doc/man/nvme_lookup_ctrl.2 b/doc/man/nvme_lookup_ctrl.2 index 6b42f4a..0718561 100644 --- a/doc/man/nvme_lookup_ctrl.2 +++ b/doc/man/nvme_lookup_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_lookup_ctrl" 9 "nvme_lookup_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_lookup_ctrl" 9 "nvme_lookup_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_lookup_ctrl \- Lookup nvme_ctrl_t object .SH SYNOPSIS diff --git a/doc/man/nvme_lookup_host.2 b/doc/man/nvme_lookup_host.2 index f5fb23c..3bbb2db 100644 --- a/doc/man/nvme_lookup_host.2 +++ b/doc/man/nvme_lookup_host.2 @@ -1,4 +1,4 @@ -.TH "nvme_lookup_host" 9 "nvme_lookup_host" "April 2022" "libnvme API manual" LINUX +.TH "nvme_lookup_host" 9 "nvme_lookup_host" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_lookup_host \- Lookup nvme_host_t object .SH SYNOPSIS diff --git a/doc/man/nvme_lookup_subsystem.2 b/doc/man/nvme_lookup_subsystem.2 index 5127f68..c80bda8 100644 --- a/doc/man/nvme_lookup_subsystem.2 +++ b/doc/man/nvme_lookup_subsystem.2 @@ -1,4 +1,4 @@ -.TH "nvme_lookup_subsystem" 9 "nvme_lookup_subsystem" "April 2022" "libnvme API manual" LINUX +.TH "nvme_lookup_subsystem" 9 "nvme_lookup_subsystem" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_lookup_subsystem \- Lookup nvme_subsystem_t object .SH SYNOPSIS @@ -15,6 +15,6 @@ Name of the subsystem (may be NULL) Subsystem NQN .SH "DESCRIPTION" Lookup a \fInvme_subsystem_t\fP object in \fIh\fP base on \fIname\fP (if present) -and \fIsubsystemnqn\fP or create one if not found. +and \fIsubsysnqn\fP or create one if not found. .SH "RETURN" -nvme_subsystme_t object +nvme_subsystem_t object diff --git a/doc/man/nvme_media_unit_config_desc.2 b/doc/man/nvme_media_unit_config_desc.2 index e739f1d..f48eec8 100644 --- a/doc/man/nvme_media_unit_config_desc.2 +++ b/doc/man/nvme_media_unit_config_desc.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_media_unit_config_desc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_media_unit_config_desc" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_media_unit_config_desc \- +struct nvme_media_unit_config_desc \- Media Unit Configuration Descriptor .SH SYNOPSIS struct nvme_media_unit_config_desc { .br @@ -17,8 +17,7 @@ struct nvme_media_unit_config_desc { .SH Members .IP "muid" 12 Media Unit Identifier +.IP "rsvd2" 12 +Reserved .IP "mudl" 12 Media Unit Descriptor Length -.SH "Description" -Media Unit Configuration Descriptor -Structure Definitions diff --git a/doc/man/nvme_media_unit_stat_desc.2 b/doc/man/nvme_media_unit_stat_desc.2 index 26282e3..efbdd9d 100644 --- a/doc/man/nvme_media_unit_stat_desc.2 +++ b/doc/man/nvme_media_unit_stat_desc.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_media_unit_stat_desc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_media_unit_stat_desc" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_media_unit_stat_desc \- +struct nvme_media_unit_stat_desc \- Media Unit Status Descriptor .SH SYNOPSIS struct nvme_media_unit_stat_desc { .br diff --git a/doc/man/nvme_media_unit_stat_log.2 b/doc/man/nvme_media_unit_stat_log.2 index 45affc3..5fc33ec 100644 --- a/doc/man/nvme_media_unit_stat_log.2 +++ b/doc/man/nvme_media_unit_stat_log.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_media_unit_stat_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_media_unit_stat_log" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_media_unit_stat_log \- +struct nvme_media_unit_stat_log \- Media Unit Status .SH SYNOPSIS struct nvme_media_unit_stat_log { .br diff --git a/doc/man/nvme_metadata_element_desc.2 b/doc/man/nvme_metadata_element_desc.2 index 32565a8..b43e9ff 100644 --- a/doc/man/nvme_metadata_element_desc.2 +++ b/doc/man/nvme_metadata_element_desc.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_metadata_element_desc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_metadata_element_desc" "July 2022" "API Manual" LINUX .SH NAME struct nvme_metadata_element_desc \- Metadata Element Descriptor .SH SYNOPSIS diff --git a/doc/man/nvme_mi_admin_get_log_page.2 b/doc/man/nvme_mi_admin_get_log_page.2 new file mode 100644 index 0000000..7d4156a --- /dev/null +++ b/doc/man/nvme_mi_admin_get_log_page.2 @@ -0,0 +1,24 @@ +.TH "nvme_mi_admin_get_log_page" 9 "nvme_mi_admin_get_log_page" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_get_log_page \- Retrieve log page data from controller +.SH SYNOPSIS +.B "int" nvme_mi_admin_get_log_page +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_get_log_args *args " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to query +.IP "args" 12 +Get Log Page command arguments +.SH "DESCRIPTION" +Performs a Get Log Page Admin command as specified by \fIargs\fP. Response data +is stored in \fIargs->data\fP, which should be a buffer of \fIargs->data_len\fP bytes. +Resulting data length is stored in \fIargs->data_len\fP on successful +command completion. + +This request may be implemented as multiple log page commands, in order +to fit within MI message-size limits. + +See: \fIstruct nvme_get_log_args\fP +.SH "RETURN" +0 on success, non-zero on failure diff --git a/doc/man/nvme_mi_admin_identify.2 b/doc/man/nvme_mi_admin_identify.2 new file mode 100644 index 0000000..d73df9e --- /dev/null +++ b/doc/man/nvme_mi_admin_identify.2 @@ -0,0 +1,23 @@ +.TH "nvme_mi_admin_identify" 9 "nvme_mi_admin_identify" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify \- Perform an Admin identify command. +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_identify_args *args " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "args" 12 +Identify command arguments +.SH "DESCRIPTION" +Perform an Identify command, using the Identify command parameters in \fIargs\fP. +Stores the identify data in ->data, and (if set) the result from cdw0 +into args->result. + +Will return an error if the length of the response data (from the +controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP. + +See: \fIstruct nvme_identify_args\fP +.SH "RETURN" +0 on success, non-zero on failure diff --git a/doc/man/nvme_mi_admin_identify_cns_nsid.2 b/doc/man/nvme_mi_admin_identify_cns_nsid.2 new file mode 100644 index 0000000..c9ebe0a --- /dev/null +++ b/doc/man/nvme_mi_admin_identify_cns_nsid.2 @@ -0,0 +1,29 @@ +.TH "nvme_mi_admin_identify_cns_nsid" 9 "nvme_mi_admin_identify_cns_nsid" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify_cns_nsid \- Perform an Admin identify command using specific CNS/NSID parameters. +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify_cns_nsid +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "enum nvme_identify_cns cns " "," +.BI "__u32 nsid " "," +.BI "void *data " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "cns" 12 +Controller or Namespace Structure, specifying identified object +.IP "nsid" 12 +namespace ID +.IP "data" 12 +buffer for identify data response +.SH "DESCRIPTION" +Perform an Identify command, using the CNS specifier \fIcns\fP, and the +namespace ID \fInsid\fP if required by the CNS type. + +Stores the identify data in \fIdata\fP, which is expected to be a buffer of +\fINVME_IDENTIFY_DATA_SIZE\fP bytes. + +Will return an error if the length of the response data (from the +controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP. +.SH "RETURN" +0 on success, non-zero on failure diff --git a/doc/man/nvme_mi_admin_identify_ctrl.2 b/doc/man/nvme_mi_admin_identify_ctrl.2 new file mode 100644 index 0000000..d624c3e --- /dev/null +++ b/doc/man/nvme_mi_admin_identify_ctrl.2 @@ -0,0 +1,23 @@ +.TH "nvme_mi_admin_identify_ctrl" 9 "nvme_mi_admin_identify_ctrl" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify_ctrl \- Perform an Admin identify for a controller +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify_ctrl +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_id_ctrl *id " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "id" 12 +Controller identify data to populate +.SH "DESCRIPTION" +Perform an Identify command, for the controller specified by \fIctrl\fP, +writing identify data to \fIid\fP. + +Will return an error if the length of the response data (from the +controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP, so \fIid\fP will be +fully populated on success. + +See: \fIstruct nvme_id_ctrl\fP +.SH "RETURN" +0 on success, non-zero on failure diff --git a/doc/man/nvme_mi_admin_identify_ctrl_list.2 b/doc/man/nvme_mi_admin_identify_ctrl_list.2 new file mode 100644 index 0000000..cdac0f0 --- /dev/null +++ b/doc/man/nvme_mi_admin_identify_ctrl_list.2 @@ -0,0 +1,26 @@ +.TH "nvme_mi_admin_identify_ctrl_list" 9 "nvme_mi_admin_identify_ctrl_list" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify_ctrl_list \- Perform an Admin identify for a controller list. +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify_ctrl_list +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "__u16 cntid " "," +.BI "struct nvme_ctrl_list *list " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "cntid" 12 +Controller ID to specify list start +.IP "list" 12 +List data to populate +.SH "DESCRIPTION" +Perform an Identify command, for the controller list starting with +IDs greater than or equal to \fIcntid\fP. + +Will return an error if the length of the response data (from the +controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP, so \fIid\fP will be +fully populated on success. + +See: \fIstruct nvme_ctrl_list\fP +.SH "RETURN" +0 on success, non-zero on failure diff --git a/doc/man/nvme_mi_admin_identify_partial.2 b/doc/man/nvme_mi_admin_identify_partial.2 new file mode 100644 index 0000000..8818ab0 --- /dev/null +++ b/doc/man/nvme_mi_admin_identify_partial.2 @@ -0,0 +1,36 @@ +.TH "nvme_mi_admin_identify_partial" 9 "nvme_mi_admin_identify_partial" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify_partial \- Perform an Admin identify command, and retrieve partial response data. +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify_partial +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_identify_args *args " "," +.BI "off_t offset " "," +.BI "size_t size " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "args" 12 +Identify command arguments +.IP "offset" 12 +offset of identify data to retrieve from response +.IP "size" 12 +size of identify data to return +.SH "DESCRIPTION" +Perform an Identify command, using the Identify command parameters in \fIargs\fP. +The \fIoffset\fP and \fIsize\fP arguments allow the caller to retrieve part of +the identify response. See NVMe-MI section 6.2 for the semantics (and some +handy diagrams) of the offset & size parameters. + +Will return an error if the length of the response data (from the controller) +did not match \fIsize\fP. + +Unless you're performing a vendor-unique identify command, You'll probably +want to use one of the identify helpers (nvme_mi_admin_identify, +nvme_mi_admin_identify_cns_nsid, or nvme_mi_admin_identify_<type>) instead +of this. If the type of your identify command is standardized but not +yet supported by libnvme-mi, please contact the maintainers. + +See: \fIstruct nvme_identify_args\fP +.SH "RETURN" +0 on success, non-zero on failure diff --git a/doc/man/nvme_mi_admin_req_hdr.2 b/doc/man/nvme_mi_admin_req_hdr.2 new file mode 100644 index 0000000..94d6bc7 --- /dev/null +++ b/doc/man/nvme_mi_admin_req_hdr.2 @@ -0,0 +1,72 @@ +.TH "libnvme" 9 "struct nvme_mi_admin_req_hdr" "July 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_admin_req_hdr \- Admin command request header. +.SH SYNOPSIS +struct nvme_mi_admin_req_hdr { +.br +.BI " struct nvme_mi_msg_hdr hdr;" +.br +.BI " __u8 opcode;" +.br +.BI " __u8 flags;" +.br +.BI " __le16 ctrl_id;" +.br +.BI " __le32 cdw1, cdw2, cdw3, cdw4, cdw5;" +.br +.BI " __le32 doff;" +.br +.BI " __le32 dlen;" +.br +.BI " __le32 rsvd0, rsvd1;" +.br +.BI " __le32 cdw10, cdw11, cdw12, cdw13, cdw14, cdw15;" +.br +.BI " +}; +.br + +.SH Members +.IP "hdr" 12 +Generic MI message header +.IP "opcode" 12 +Admin command opcode (using enum nvme_admin_opcode) +.IP "flags" 12 +Command Flags, indicating dlen and doff validity; Only defined in +NVMe-MI version 1.1, no fields defined in 1.2 (where the dlen/doff +are always considered valid). +.IP "ctrl_id" 12 +Controller ID target of command +.IP "cdw1" 12 +Submission Queue Entry doubleword 1 +.IP "cdw2" 12 +Submission Queue Entry doubleword 2 +.IP "cdw3" 12 +Submission Queue Entry doubleword 3 +.IP "cdw4" 12 +Submission Queue Entry doubleword 4 +.IP "cdw5" 12 +Submission Queue Entry doubleword 5 +.IP "doff" 12 +Offset of data to return from command +.IP "dlen" 12 +Length of sent/returned data +.IP "rsvd0" 12 +Reserved +.IP "rsvd1" 12 +Reserved +.IP "cdw10" 12 +Submission Queue Entry doubleword 10 +.IP "cdw11" 12 +Submission Queue Entry doubleword 11 +.IP "cdw12" 12 +Submission Queue Entry doubleword 12 +.IP "cdw13" 12 +Submission Queue Entry doubleword 13 +.IP "cdw14" 12 +Submission Queue Entry doubleword 14 +.IP "cdw15" 12 +Submission Queue Entry doubleword 15 +.SH "Description" +Wire format for Admin command message headers, defined in section 6 of +NVMe-MI. diff --git a/doc/man/nvme_mi_admin_resp_hdr.2 b/doc/man/nvme_mi_admin_resp_hdr.2 new file mode 100644 index 0000000..383a83f --- /dev/null +++ b/doc/man/nvme_mi_admin_resp_hdr.2 @@ -0,0 +1,34 @@ +.TH "libnvme" 9 "struct nvme_mi_admin_resp_hdr" "July 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_admin_resp_hdr \- Admin command response header. +.SH SYNOPSIS +struct nvme_mi_admin_resp_hdr { +.br +.BI " struct nvme_mi_msg_hdr hdr;" +.br +.BI " __u8 status;" +.br +.BI " __u8 rsvd0[3];" +.br +.BI " __le32 cdw0, cdw1, cdw3;" +.br +.BI " +}; +.br + +.SH Members +.IP "hdr" 12 +Generic MI message header +.IP "status" 12 +Generic response code, non-zero on failure +.IP "rsvd0" 12 +Reserved +.IP "cdw0" 12 +Completion Queue Entry doubleword 0 +.IP "cdw1" 12 +Completion Queue Entry doubleword 1 +.IP "cdw3" 12 +Completion Queue Entry doubleword 3 +.SH "Description" +This is the generic response format with the three doublewords of completion +queue data, plus optional response data. diff --git a/doc/man/nvme_mi_admin_security_recv.2 b/doc/man/nvme_mi_admin_security_recv.2 new file mode 100644 index 0000000..cb658d4 --- /dev/null +++ b/doc/man/nvme_mi_admin_security_recv.2 @@ -0,0 +1,24 @@ +.TH "nvme_mi_admin_security_recv" 9 "nvme_mi_admin_security_recv" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_security_recv \- Perform a Security Receive command on a controller. +.SH SYNOPSIS +.B "int" nvme_mi_admin_security_recv +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_security_receive_args *args " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to send command to +.IP "args" 12 +Security Receive command arguments +.SH "DESCRIPTION" +Performs a Security Receive Admin command as specified by \fIargs\fP. Response +data is stored in \fIargs->data\fP, which should be a buffer of \fIargs->data_len\fP +bytes. Resulting data length is stored in \fIargs->data_len\fP on successful +command completion. + +Security Receive data length should not be greater than 4096 bytes to +comply with specification limits. + +See: \fIstruct nvme_get_log_args\fP +.SH "RETURN" +0 on success, non-zero on failure diff --git a/doc/man/nvme_mi_admin_security_send.2 b/doc/man/nvme_mi_admin_security_send.2 new file mode 100644 index 0000000..37aed3e --- /dev/null +++ b/doc/man/nvme_mi_admin_security_send.2 @@ -0,0 +1,24 @@ +.TH "nvme_mi_admin_security_send" 9 "nvme_mi_admin_security_send" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_security_send \- Perform a Security Send command on a controller. +.SH SYNOPSIS +.B "int" nvme_mi_admin_security_send +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_security_send_args *args " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to send command to +.IP "args" 12 +Security Send command arguments +.SH "DESCRIPTION" +Performs a Security Send Admin command as specified by \fIargs\fP. Response data +is stored in \fIargs->data\fP, which should be a buffer of \fIargs->data_len\fP bytes. +Resulting data length is stored in \fIargs->data_len\fP on successful +command completion. + +Security Send data length should not be greater than 4096 bytes to +comply with specification limits. + +See: \fIstruct nvme_get_log_args\fP +.SH "RETURN" +0 on success, non-zero on failure diff --git a/doc/man/nvme_mi_admin_xfer.2 b/doc/man/nvme_mi_admin_xfer.2 new file mode 100644 index 0000000..a86e8bf --- /dev/null +++ b/doc/man/nvme_mi_admin_xfer.2 @@ -0,0 +1,41 @@ +.TH "nvme_mi_admin_xfer" 9 "nvme_mi_admin_xfer" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_xfer \- Raw admin transfer interface. +.SH SYNOPSIS +.B "int" nvme_mi_admin_xfer +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_mi_admin_req_hdr *admin_req " "," +.BI "size_t req_data_size " "," +.BI "struct nvme_mi_admin_resp_hdr *admin_resp " "," +.BI "off_t resp_data_offset " "," +.BI "size_t *resp_data_size " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +controller to send the admin command to +.IP "admin_req" 12 +request data +.IP "req_data_size" 12 +size of request data payload +.IP "admin_resp" 12 +buffer for response data +.IP "resp_data_offset" 12 +offset into request data to retrieve from controller +.IP "resp_data_size" 12 +size of response data buffer, updated to received size +.SH "DESCRIPTION" +Performs an arbitrary NVMe Admin command, using the provided request data, +in \fIadmin_req\fP. The size of the request data *payload* is specified in +\fIreq_data_size\fP - this does not include the standard header length (so a +header-only request would have a size of 0). + +On success, response data is stored in \fIadmin_resp\fP, which has an optional +appended payload buffer of \fIresp_data_size\fP bytes. The actual payload +transferred will be stored in \fIresp_data_size\fP. These sizes do not include +the Admin request header, so 0 represents no payload. + +As with all Admin commands, we can request partial data from the Admin +Response payload, offset by \fIresp_data_offset\fP. + +See: \fIstruct nvme_mi_admin_req_hdr\fP and \fIstruct nvme_mi_admin_resp_hdr\fP. +.SH "RETURN" +0 on success, non-zero on failure. diff --git a/doc/man/nvme_mi_ccs.2 b/doc/man/nvme_mi_ccs.2 new file mode 100644 index 0000000..266508c --- /dev/null +++ b/doc/man/nvme_mi_ccs.2 @@ -0,0 +1,78 @@ +.TH "libnvme" 9 "enum nvme_mi_ccs" "July 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_ccs \- Get State Control Primitive Success Response Fields - Control Primitive Specific Response +.SH SYNOPSIS +enum nvme_mi_ccs { +.br +.BI " NVME_MI_CCS_RDY" +, +.br +.br +.BI " NVME_MI_CCS_CFS" +, +.br +.br +.BI " NVME_MI_CCS_SHST" +, +.br +.br +.BI " NVME_MI_CCS_NSSRO" +, +.br +.br +.BI " NVME_MI_CCS_CECO" +, +.br +.br +.BI " NVME_MI_CCS_NAC" +, +.br +.br +.BI " NVME_MI_CCS_FA" +, +.br +.br +.BI " NVME_MI_CCS_CSTS" +, +.br +.br +.BI " NVME_MI_CCS_CTEMP" +, +.br +.br +.BI " NVME_MI_CCS_PDLU" +, +.br +.br +.BI " NVME_MI_CCS_SPARE" +, +.br +.br +.BI " NVME_MI_CCS_CCWARN" + +}; +.SH Constants +.IP "NVME_MI_CCS_RDY" 12 +Ready +.IP "NVME_MI_CCS_CFS" 12 +Controller Fatal Status +.IP "NVME_MI_CCS_SHST" 12 +Shutdown Status +.IP "NVME_MI_CCS_NSSRO" 12 +NVM Subsystem Reset Occurred +.IP "NVME_MI_CCS_CECO" 12 +Controller Enable Change Occurred +.IP "NVME_MI_CCS_NAC" 12 +Namespace Attribute Changed +.IP "NVME_MI_CCS_FA" 12 +Firmware Activated +.IP "NVME_MI_CCS_CSTS" 12 +Controller Status Change +.IP "NVME_MI_CCS_CTEMP" 12 +Composite Temperature Change +.IP "NVME_MI_CCS_PDLU" 12 +Percentage Used +.IP "NVME_MI_CCS_SPARE" 12 +Available Spare +.IP "NVME_MI_CCS_CCWARN" 12 +Critical Warning diff --git a/doc/man/nvme_mi_close.2 b/doc/man/nvme_mi_close.2 new file mode 100644 index 0000000..ab0f9b6 --- /dev/null +++ b/doc/man/nvme_mi_close.2 @@ -0,0 +1,9 @@ +.TH "nvme_mi_close" 9 "nvme_mi_close" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_close \- Close an endpoint connection and release resources, including controller objects. +.SH SYNOPSIS +.B "void" nvme_mi_close +.BI "(nvme_mi_ep_t ep " ");" +.SH ARGUMENTS +.IP "ep" 12 +Endpoint object to close diff --git a/doc/man/nvme_mi_close_ctrl.2 b/doc/man/nvme_mi_close_ctrl.2 new file mode 100644 index 0000000..51cbbf4 --- /dev/null +++ b/doc/man/nvme_mi_close_ctrl.2 @@ -0,0 +1,9 @@ +.TH "nvme_mi_close_ctrl" 9 "nvme_mi_close_ctrl" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_close_ctrl \- free a controller +.SH SYNOPSIS +.B "void" nvme_mi_close_ctrl +.BI "(nvme_mi_ctrl_t ctrl " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +controller to free diff --git a/doc/man/nvme_mi_cmd_supported_effects.2 b/doc/man/nvme_mi_cmd_supported_effects.2 index 14a723d..9ff7cc3 100644 --- a/doc/man/nvme_mi_cmd_supported_effects.2 +++ b/doc/man/nvme_mi_cmd_supported_effects.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_mi_cmd_supported_effects" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_mi_cmd_supported_effects" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_mi_cmd_supported_effects \- bit field definitions +enum nvme_mi_cmd_supported_effects \- MI Command Supported and Effects Data Structure .SH SYNOPSIS enum nvme_mi_cmd_supported_effects { .br @@ -59,7 +59,7 @@ enum nvme_mi_cmd_supported_effects { .IP "NVME_MI_CMD_SUPPORTED_EFFECTS_CSUPP" 12 Command Supported .IP "NVME_MI_CMD_SUPPORTED_EFFECTS_UDCC" 12 -User Data Conttent Change +User Data Content Change .IP "NVME_MI_CMD_SUPPORTED_EFFECTS_NCC" 12 Namespace Capability Change .IP "NVME_MI_CMD_SUPPORTED_EFFECTS_NIC" 12 @@ -82,5 +82,3 @@ Endurance Group Scope Domain Scope .IP "NVME_MI_CMD_SUPPORTED_EFFECTS_SCOPE_NSS" 12 NVM Subsystem Scope -.SH "Description" -MI Command Supported and Effects Data Structure definitions diff --git a/doc/man/nvme_mi_cmd_supported_effects_log.2 b/doc/man/nvme_mi_cmd_supported_effects_log.2 index 96763e7..6d541bb 100644 --- a/doc/man/nvme_mi_cmd_supported_effects_log.2 +++ b/doc/man/nvme_mi_cmd_supported_effects_log.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_cmd_supported_effects_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_cmd_supported_effects_log" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_cmd_supported_effects_log \- +struct nvme_mi_cmd_supported_effects_log \- NVMe-MI Commands Supported and Effects Log .SH SYNOPSIS struct nvme_mi_cmd_supported_effects_log { .br @@ -15,5 +15,5 @@ struct nvme_mi_cmd_supported_effects_log { .SH Members .IP "mi_cmd_support" 12 NVMe-MI Commands Supported -.SH "Description" -NVMe-MI Commands Supported and Effects (Log Identifier 13h) +.IP "reserved1" 12 +Reserved diff --git a/doc/man/nvme_mi_config_id.2 b/doc/man/nvme_mi_config_id.2 new file mode 100644 index 0000000..9d4bd2f --- /dev/null +++ b/doc/man/nvme_mi_config_id.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "enum nvme_mi_config_id" "July 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_config_id \- NVMe-MI Configuration identifier. +.SH SYNOPSIS +enum nvme_mi_config_id { +.br +.BI " NVME_MI_CONFIG_SMBUS_FREQ" +, +.br +.br +.BI " NVME_MI_CONFIG_HEALTH_STATUS_CHANGE" +, +.br +.br +.BI " NVME_MI_CONFIG_MCTP_MTU" + +}; +.SH Constants +.IP "NVME_MI_CONFIG_SMBUS_FREQ" 12 +Current SMBus/I2C frequency +.IP "NVME_MI_CONFIG_HEALTH_STATUS_CHANGE" 12 +Health Status change - used to clear +health status bits in CCS bits of +status poll. Only for Set ops. +.IP "NVME_MI_CONFIG_MCTP_MTU" 12 +MCTP maximum transmission unit size of port +specified in dw 0 +.SH "Description" +Configuration parameters for the MI Get/Set Configuration commands. + +See &\fBnvme_mi_mi_config_get\fP and &\fBnvme_mi_config_set\fP. diff --git a/doc/man/nvme_mi_config_smbus_freq.2 b/doc/man/nvme_mi_config_smbus_freq.2 new file mode 100644 index 0000000..2987dca --- /dev/null +++ b/doc/man/nvme_mi_config_smbus_freq.2 @@ -0,0 +1,27 @@ +.TH "libnvme" 9 "enum nvme_mi_config_smbus_freq" "July 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_config_smbus_freq \- SMBus/I2C frequency values +.SH SYNOPSIS +enum nvme_mi_config_smbus_freq { +.br +.BI " NVME_MI_CONFIG_SMBUS_FREQ_100kHz" +, +.br +.br +.BI " NVME_MI_CONFIG_SMBUS_FREQ_400kHz" +, +.br +.br +.BI " NVME_MI_CONFIG_SMBUS_FREQ_1MHz" + +}; +.SH Constants +.IP "NVME_MI_CONFIG_SMBUS_FREQ_100kHz" 12 +100kHz +.IP "NVME_MI_CONFIG_SMBUS_FREQ_400kHz" 12 +400kHz +.IP "NVME_MI_CONFIG_SMBUS_FREQ_1MHz" 12 +1MHz +.SH "Description" +Values used in the SMBus Frequency device configuration. See +&\fBnvme_mi_mi_config_get_smbus_freq\fP and &\fBnvme_mi_mi_config_set_smbus_freq\fP. diff --git a/doc/man/nvme_mi_create_root.2 b/doc/man/nvme_mi_create_root.2 new file mode 100644 index 0000000..f24216a --- /dev/null +++ b/doc/man/nvme_mi_create_root.2 @@ -0,0 +1,20 @@ +.TH "nvme_mi_create_root" 9 "nvme_mi_create_root" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_create_root \- Create top-level MI (root) handle. +.SH SYNOPSIS +.B "nvme_root_t" nvme_mi_create_root +.BI "(FILE *fp " "," +.BI "int log_level " ");" +.SH ARGUMENTS +.IP "fp" 12 +File descriptor for logging messages +.IP "log_level" 12 +Logging level to use +.SH "DESCRIPTION" +Create the top-level (library) handle for creating subsequent endpoint +objects. Similar to \fBnvme_create_root\fP, but we provide this to allow linking +without the core libnvme. + +See \fInvme_create_root\fP. +.SH "RETURN" +new root object, or NULL on failure. diff --git a/doc/man/nvme_mi_css.2 b/doc/man/nvme_mi_css.2 deleted file mode 100644 index f75db9e..0000000 --- a/doc/man/nvme_mi_css.2 +++ /dev/null @@ -1,78 +0,0 @@ -.TH "libnvme" 9 "enum nvme_mi_css" "April 2022" "API Manual" LINUX -.SH NAME -enum nvme_mi_css \- -.SH SYNOPSIS -enum nvme_mi_css { -.br -.BI " NVME_MI_CCS_RDY" -, -.br -.br -.BI " NVME_MI_CSS_CFS" -, -.br -.br -.BI " NVME_MI_CSS_SHST" -, -.br -.br -.BI " NVME_MI_CSS_NSSRO" -, -.br -.br -.BI " NVME_MI_CSS_CECO" -, -.br -.br -.BI " NVME_MI_CSS_NAC" -, -.br -.br -.BI " NVME_MI_CSS_FA" -, -.br -.br -.BI " NVME_MI_CSS_CSTS" -, -.br -.br -.BI " NVME_MI_CSS_CTEMP" -, -.br -.br -.BI " NVME_MI_CSS_PDLU" -, -.br -.br -.BI " NVME_MI_CSS_SPARE" -, -.br -.br -.BI " NVME_MI_CSS_CCWARN" - -}; -.SH Constants -.IP "NVME_MI_CCS_RDY" 12 -Ready -.IP "NVME_MI_CSS_CFS" 12 -Controller Fatal Status -.IP "NVME_MI_CSS_SHST" 12 -Shutdown Status -.IP "NVME_MI_CSS_NSSRO" 12 -NVM Subsystem Reset Occurred -.IP "NVME_MI_CSS_CECO" 12 -Controller Enable Change Occurred -.IP "NVME_MI_CSS_NAC" 12 -Namespace Attribute Changed -.IP "NVME_MI_CSS_FA" 12 -Firmware Activated -.IP "NVME_MI_CSS_CSTS" 12 -Controller Status Change -.IP "NVME_MI_CSS_CTEMP" 12 -Composite Temperature Change -.IP "NVME_MI_CSS_PDLU" 12 -Percentage Used -.IP "NVME_MI_CSS_SPARE" 12 -Available Spare -.IP "NVME_MI_CSS_CCWARN" 12 -Critical Warning diff --git a/doc/man/nvme_mi_csts.2 b/doc/man/nvme_mi_csts.2 index f9e388a..23a009c 100644 --- a/doc/man/nvme_mi_csts.2 +++ b/doc/man/nvme_mi_csts.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_mi_csts" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_mi_csts" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_mi_csts \- +enum nvme_mi_csts \- Controller Health Data Structure (CHDS) - Controller Status (CSTS) .SH SYNOPSIS enum nvme_mi_csts { .br diff --git a/doc/man/nvme_mi_ctrl_health_status.2 b/doc/man/nvme_mi_ctrl_health_status.2 index 76cb616..ab79056 100644 --- a/doc/man/nvme_mi_ctrl_health_status.2 +++ b/doc/man/nvme_mi_ctrl_health_status.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_ctrl_health_status" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_ctrl_health_status" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_ctrl_health_status \- +struct nvme_mi_ctrl_health_status \- Controller Health Data Structure (CHDS) .SH SYNOPSIS struct nvme_mi_ctrl_health_status { .br diff --git a/doc/man/nvme_mi_cwarn.2 b/doc/man/nvme_mi_cwarn.2 index 11ccbc8..4b5ee22 100644 --- a/doc/man/nvme_mi_cwarn.2 +++ b/doc/man/nvme_mi_cwarn.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_mi_cwarn" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_mi_cwarn" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_mi_cwarn \- +enum nvme_mi_cwarn \- Controller Health Data Structure (CHDS) - Critical Warning (CWARN) .SH SYNOPSIS enum nvme_mi_cwarn { .br diff --git a/doc/man/nvme_mi_dtyp.2 b/doc/man/nvme_mi_dtyp.2 new file mode 100644 index 0000000..20df415 --- /dev/null +++ b/doc/man/nvme_mi_dtyp.2 @@ -0,0 +1,45 @@ +.TH "libnvme" 9 "enum nvme_mi_dtyp" "July 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_dtyp \- Data Structure Type field. +.SH SYNOPSIS +enum nvme_mi_dtyp { +.br +.BI " nvme_mi_dtyp_subsys_info" +, +.br +.br +.BI " nvme_mi_dtyp_port_info" +, +.br +.br +.BI " nvme_mi_dtyp_ctrl_list" +, +.br +.br +.BI " nvme_mi_dtyp_ctrl_info" +, +.br +.br +.BI " nvme_mi_dtyp_opt_cmd_support" +, +.br +.br +.BI " nvme_mi_dtyp_meb_support" + +}; +.SH Constants +.IP "nvme_mi_dtyp_subsys_info" 12 +NVM Subsystem Information +.IP "nvme_mi_dtyp_port_info" 12 +Port information +.IP "nvme_mi_dtyp_ctrl_list" 12 +Controller List +.IP "nvme_mi_dtyp_ctrl_info" 12 +Controller Information +.IP "nvme_mi_dtyp_opt_cmd_support" 12 +Optionally Supported Command List +.IP "nvme_mi_dtyp_meb_support" 12 +Management Endpoint Buffer Command Support List +.SH "Description" +Data Structure Type field for Read NVMe-MI Data Structure command, used to +indicate the particular structure to query from the endpoint. diff --git a/doc/man/nvme_mi_elem.2 b/doc/man/nvme_mi_elem.2 index 17be0ef..10c4803 100644 --- a/doc/man/nvme_mi_elem.2 +++ b/doc/man/nvme_mi_elem.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_mi_elem" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_mi_elem" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_mi_elem \- +enum nvme_mi_elem \- Element Descriptor Types .SH SYNOPSIS enum nvme_mi_elem { .br diff --git a/doc/man/nvme_mi_free_root.2 b/doc/man/nvme_mi_free_root.2 new file mode 100644 index 0000000..bb6e5cb --- /dev/null +++ b/doc/man/nvme_mi_free_root.2 @@ -0,0 +1,9 @@ +.TH "nvme_mi_free_root" 9 "nvme_mi_free_root" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_free_root \- Free root object. +.SH SYNOPSIS +.B "void" nvme_mi_free_root +.BI "(nvme_root_t root " ");" +.SH ARGUMENTS +.IP "root" 12 +root to free diff --git a/doc/man/nvme_mi_init_ctrl.2 b/doc/man/nvme_mi_init_ctrl.2 new file mode 100644 index 0000000..f8e84ec --- /dev/null +++ b/doc/man/nvme_mi_init_ctrl.2 @@ -0,0 +1,20 @@ +.TH "nvme_mi_init_ctrl" 9 "nvme_mi_init_ctrl" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_init_ctrl \- initialise a NVMe controller. +.SH SYNOPSIS +.B "nvme_mi_ctrl_t" nvme_mi_init_ctrl +.BI "(nvme_mi_ep_t ep " "," +.BI "__u16 ctrl_id " ");" +.SH ARGUMENTS +.IP "ep" 12 +Endpoint to create under +.IP "ctrl_id" 12 +ID of controller to initialize. +.SH "DESCRIPTION" +Create a connection to a controller behind the endpoint specified in \fIep\fP. +Controller IDs may be queried from the endpoint through +\fInvme_mi_mi_read_mi_data_ctrl_list\fP. + +See \fInvme_mi_close_ctrl\fP +.SH "RETURN" +New controller object, or NULL on failure. diff --git a/doc/man/nvme_mi_message_type.2 b/doc/man/nvme_mi_message_type.2 new file mode 100644 index 0000000..450992f --- /dev/null +++ b/doc/man/nvme_mi_message_type.2 @@ -0,0 +1,33 @@ +.TH "libnvme" 9 "enum nvme_mi_message_type" "July 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_message_type \- NVMe-MI message type field. +.SH SYNOPSIS +enum nvme_mi_message_type { +.br +.BI " NVME_MI_MT_CONTROL" +, +.br +.br +.BI " NVME_MI_MT_MI" +, +.br +.br +.BI " NVME_MI_MT_ADMIN" +, +.br +.br +.BI " NVME_MI_MT_PCIE" + +}; +.SH Constants +.IP "NVME_MI_MT_CONTROL" 12 +NVME-MI Control Primitive +.IP "NVME_MI_MT_MI" 12 +NVMe-MI command +.IP "NVME_MI_MT_ADMIN" 12 +NVMe Admin command +.IP "NVME_MI_MT_PCIE" 12 +PCIe command +.SH "Description" +Used as byte 1 of both request and response messages (NMIMT bits of NMP +byte). Not to be confused with the MCTP message type in byte 0. diff --git a/doc/man/nvme_mi_mi_opcode.2 b/doc/man/nvme_mi_mi_opcode.2 new file mode 100644 index 0000000..64cbac9 --- /dev/null +++ b/doc/man/nvme_mi_mi_opcode.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "enum nvme_mi_mi_opcode" "July 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_mi_opcode \- Operation code for supported NVMe-MI commands. +.SH SYNOPSIS +enum nvme_mi_mi_opcode { +.br +.BI " nvme_mi_mi_opcode_mi_data_read" +, +.br +.br +.BI " nvme_mi_mi_opcode_subsys_health_status_poll" +, +.br +.br +.BI " nvme_mi_mi_opcode_configuration_set" +, +.br +.br +.BI " nvme_mi_mi_opcode_configuration_get" + +}; +.SH Constants +.IP "nvme_mi_mi_opcode_mi_data_read" 12 +Read NVMe-MI Data Structure +.IP "nvme_mi_mi_opcode_subsys_health_status_poll" 12 +Subsystem Health Status Poll +.IP "nvme_mi_mi_opcode_configuration_set" 12 +MI Configuration Set +.IP "nvme_mi_mi_opcode_configuration_get" 12 +MI Configuration Get diff --git a/doc/man/nvme_mi_mi_read_mi_data_ctrl.2 b/doc/man/nvme_mi_mi_read_mi_data_ctrl.2 new file mode 100644 index 0000000..8d5603c --- /dev/null +++ b/doc/man/nvme_mi_mi_read_mi_data_ctrl.2 @@ -0,0 +1,22 @@ +.TH "nvme_mi_mi_read_mi_data_ctrl" 9 "nvme_mi_mi_read_mi_data_ctrl" "July 2022" "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 +.B "int" nvme_mi_mi_read_mi_data_ctrl +.BI "(nvme_mi_ep_t ep " "," +.BI "__u16 ctrl_id " "," +.BI "struct nvme_mi_read_ctrl_info *ctrl " ");" +.SH ARGUMENTS +.IP "ep" 12 +endpoint for MI communication +.IP "ctrl_id" 12 +ID of controller to query +.IP "ctrl" 12 +controller data to populate +.SH "DESCRIPTION" +Retrieves the Controller Information Data Structure for the attached +controller with ID \fIctrlid\fP. + +See \fIstruct nvme_mi_read_ctrl_info\fP. +.SH "RETURN" +0 on success, non-zero on failure. diff --git a/doc/man/nvme_mi_mi_read_mi_data_ctrl_list.2 b/doc/man/nvme_mi_mi_read_mi_data_ctrl_list.2 new file mode 100644 index 0000000..9db63e5 --- /dev/null +++ b/doc/man/nvme_mi_mi_read_mi_data_ctrl_list.2 @@ -0,0 +1,22 @@ +.TH "nvme_mi_mi_read_mi_data_ctrl_list" 9 "nvme_mi_mi_read_mi_data_ctrl_list" "July 2022" "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 +.B "int" nvme_mi_mi_read_mi_data_ctrl_list +.BI "(nvme_mi_ep_t ep " "," +.BI "__u8 start_ctrlid " "," +.BI "struct nvme_ctrl_list *list " ");" +.SH ARGUMENTS +.IP "ep" 12 +endpoint for MI communication +.IP "start_ctrlid" 12 +starting controller ID +.IP "list" 12 +controller list to populate +.SH "DESCRIPTION" +Retrieves the list of attached controllers, with IDs greater than or +equal to \fIstart_ctrlid\fP. + +See \fIstruct nvme_ctrl_list\fP. +.SH "RETURN" +0 on success, non-zero on failure. diff --git a/doc/man/nvme_mi_mi_read_mi_data_port.2 b/doc/man/nvme_mi_mi_read_mi_data_port.2 new file mode 100644 index 0000000..4a20637 --- /dev/null +++ b/doc/man/nvme_mi_mi_read_mi_data_port.2 @@ -0,0 +1,23 @@ +.TH "nvme_mi_mi_read_mi_data_port" 9 "nvme_mi_mi_read_mi_data_port" "July 2022" "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 +.B "int" nvme_mi_mi_read_mi_data_port +.BI "(nvme_mi_ep_t ep " "," +.BI "__u8 portid " "," +.BI "struct nvme_mi_read_port_info *p " ");" +.SH ARGUMENTS +.IP "ep" 12 +endpoint for MI communication +.IP "portid" 12 +id of port data to retrieve +.IP "p" 12 +port information to populate +.SH "DESCRIPTION" +Retrieves the Port information, for the specified port ID. The subsystem +data (from \fInvme_mi_mi_read_mi_data_subsys\fP) nmp field contains the allowed +range of port IDs. + +See \fIstruct nvme_mi_read_port_info\fP. +.SH "RETURN" +0 on success, non-zero on failure. diff --git a/doc/man/nvme_mi_mi_read_mi_data_subsys.2 b/doc/man/nvme_mi_mi_read_mi_data_subsys.2 new file mode 100644 index 0000000..0250794 --- /dev/null +++ b/doc/man/nvme_mi_mi_read_mi_data_subsys.2 @@ -0,0 +1,17 @@ +.TH "nvme_mi_mi_read_mi_data_subsys" 9 "nvme_mi_mi_read_mi_data_subsys" "July 2022" "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 +.B "int" nvme_mi_mi_read_mi_data_subsys +.BI "(nvme_mi_ep_t ep " "," +.BI "struct nvme_mi_read_nvm_ss_info *s " ");" +.SH ARGUMENTS +.IP "ep" 12 +endpoint for MI communication +.IP "s" 12 +subsystem information to populate +.SH "DESCRIPTION" +Retrieves the Subsystem information - number of external ports and +NVMe version information. See \fIstruct nvme_mi_read_nvm_ss_info\fP. +.SH "RETURN" +0 on success, non-zero on failure. diff --git a/doc/man/nvme_mi_mi_req_hdr.2 b/doc/man/nvme_mi_mi_req_hdr.2 new file mode 100644 index 0000000..6d2e9c5 --- /dev/null +++ b/doc/man/nvme_mi_mi_req_hdr.2 @@ -0,0 +1,31 @@ +.TH "libnvme" 9 "struct nvme_mi_mi_req_hdr" "July 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_mi_req_hdr \- MI request message header. +.SH SYNOPSIS +struct nvme_mi_mi_req_hdr { +.br +.BI " struct nvme_mi_msg_hdr hdr;" +.br +.BI " __u8 opcode;" +.br +.BI " __u8 rsvd0[3];" +.br +.BI " __le32 cdw0, cdw1;" +.br +.BI " +}; +.br + +.SH Members +.IP "hdr" 12 +generic MI message header +.IP "opcode" 12 +opcode (OPC) for the specific MI command +.IP "rsvd0" 12 +reserved bytes +.IP "cdw0" 12 +Management Request Doubleword 0 - command specific usage +.IP "cdw1" 12 +Management Request Doubleword 1 - command specific usage +.SH "Description" +Wire format for MI request message headers, defined in section 5 of NVMe-MI. diff --git a/doc/man/nvme_mi_mi_resp_hdr.2 b/doc/man/nvme_mi_mi_resp_hdr.2 new file mode 100644 index 0000000..6c601a5 --- /dev/null +++ b/doc/man/nvme_mi_mi_resp_hdr.2 @@ -0,0 +1,25 @@ +.TH "libnvme" 9 "struct nvme_mi_mi_resp_hdr" "July 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_mi_resp_hdr \- MI response message header. +.SH SYNOPSIS +struct nvme_mi_mi_resp_hdr { +.br +.BI " struct nvme_mi_msg_hdr hdr;" +.br +.BI " __u8 status;" +.br +.BI " __u8 nmresp[3];" +.br +.BI " +}; +.br + +.SH Members +.IP "hdr" 12 +generic MI message header +.IP "status" 12 +generic response status from command; non-zero on failure. +.IP "nmresp" 12 +NVMe Management Response: command-type-specific response data +.SH "Description" +Wire format for MI response message header, defined in section 5 of NVMe-MI. diff --git a/doc/man/nvme_mi_mi_subsystem_health_status_poll.2 b/doc/man/nvme_mi_mi_subsystem_health_status_poll.2 new file mode 100644 index 0000000..8f0dbb4 --- /dev/null +++ b/doc/man/nvme_mi_mi_subsystem_health_status_poll.2 @@ -0,0 +1,23 @@ +.TH "nvme_mi_mi_subsystem_health_status_poll" 9 "nvme_mi_mi_subsystem_health_status_poll" "July 2022" "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 +.B "int" nvme_mi_mi_subsystem_health_status_poll +.BI "(nvme_mi_ep_t ep " "," +.BI "bool clear " "," +.BI "struct nvme_mi_nvm_ss_health_status *nshds " ");" +.SH ARGUMENTS +.IP "ep" 12 +endpoint for MI communication +.IP "clear" 12 +flag to clear the Composite Controller Status state +.IP "nshds" 12 +subsystem health status data to populate +.SH "DESCRIPTION" +Retrieves the Subsystem Health Data Structure into \fInshds\fP. If \fIclear\fP is +set, requests that the Composite Controller Status bits are cleared after +the read. See NVMe-MI section 5.6 for details on the CCS bits. + +See \fIstruct nvme_mi_nvm_ss_health_status\fP. +.SH "RETURN" +0 on success, non-zero on failure. diff --git a/doc/man/nvme_mi_msg_hdr.2 b/doc/man/nvme_mi_msg_hdr.2 new file mode 100644 index 0000000..1609661 --- /dev/null +++ b/doc/man/nvme_mi_msg_hdr.2 @@ -0,0 +1,30 @@ +.TH "libnvme" 9 "struct nvme_mi_msg_hdr" "July 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_msg_hdr \- General MI message header. +.SH SYNOPSIS +struct nvme_mi_msg_hdr { +.br +.BI " __u8 type;" +.br +.BI " __u8 nmp;" +.br +.BI " __u8 meb;" +.br +.BI " __u8 rsvd0;" +.br +.BI " +}; +.br + +.SH Members +.IP "type" 12 +MCTP message type, will always be NVME_MI_MSGTYPE_NVME +.IP "nmp" 12 +NVMe-MI message parameters (including MI message type) +.IP "meb" 12 +Management Endpoint Buffer flag; unused for libnvme-mi implementation +.IP "rsvd0" 12 +currently reserved +.SH "Description" +Wire format shared by both request and response messages, per NVMe-MI +section 3.1. This is used for all message types, MI and Admin. diff --git a/doc/man/nvme_mi_msg_resp.2 b/doc/man/nvme_mi_msg_resp.2 new file mode 100644 index 0000000..2b85435 --- /dev/null +++ b/doc/man/nvme_mi_msg_resp.2 @@ -0,0 +1,26 @@ +.TH "libnvme" 9 "struct nvme_mi_msg_resp" "July 2022" "API Manual" LINUX +.SH NAME +struct nvme_mi_msg_resp \- Generic response type. +.SH SYNOPSIS +struct nvme_mi_msg_resp { +.br +.BI " struct nvme_mi_msg_hdr hdr;" +.br +.BI " __u8 status;" +.br +.BI " __u8 rsvd0[3];" +.br +.BI " +}; +.br + +.SH Members +.IP "hdr" 12 +the general request/response message header +.IP "status" 12 +response status value (see \fIenum nvme_mi_resp_status\fP) +.IP "rsvd0" 12 +reserved data, may be defined by specific response +.SH "Description" +Every response will start with one of these; command-specific responses +will define parts of the reserved data, and may add further fields. diff --git a/doc/man/nvme_mi_nvm_ss_health_status.2 b/doc/man/nvme_mi_nvm_ss_health_status.2 index 55c6d96..7179d74 100644 --- a/doc/man/nvme_mi_nvm_ss_health_status.2 +++ b/doc/man/nvme_mi_nvm_ss_health_status.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_nvm_ss_health_status" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_nvm_ss_health_status" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_nvm_ss_health_status \- +struct nvme_mi_nvm_ss_health_status \- Subsystem Management Data Structure .SH SYNOPSIS struct nvme_mi_nvm_ss_health_status { .br diff --git a/doc/man/nvme_mi_open_mctp.2 b/doc/man/nvme_mi_open_mctp.2 new file mode 100644 index 0000000..cb3c410 --- /dev/null +++ b/doc/man/nvme_mi_open_mctp.2 @@ -0,0 +1,22 @@ +.TH "nvme_mi_open_mctp" 9 "nvme_mi_open_mctp" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_open_mctp \- Create an endpoint using a MCTP connection. +.SH SYNOPSIS +.B "nvme_mi_ep_t" nvme_mi_open_mctp +.BI "(nvme_root_t root " "," +.BI "unsigned int netid " "," +.BI "uint8_t eid " ");" +.SH ARGUMENTS +.IP "root" 12 +root object to create under +.IP "netid" 12 +MCTP network ID on this system +.IP "eid" 12 +MCTP endpoint ID +.SH "DESCRIPTION" +Transport-specific endpoint initialization for MI-connected endpoints. Once +an endpoint is created, the rest of the API is transport-independent. + +See \fInvme_mi_close\fP +.SH "RETURN" +New endpoint object for \fInetid\fP & \fIeid\fP, or NULL on failure. diff --git a/doc/man/nvme_mi_osc.2 b/doc/man/nvme_mi_osc.2 index df270a2..a53da59 100644 --- a/doc/man/nvme_mi_osc.2 +++ b/doc/man/nvme_mi_osc.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_osc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_osc" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_osc \- +struct nvme_mi_osc \- Optionally Supported Command Data Structure .SH SYNOPSIS struct nvme_mi_osc { .br diff --git a/doc/man/nvme_mi_port_pcie.2 b/doc/man/nvme_mi_port_pcie.2 index 5221f02..3b0bbb9 100644 --- a/doc/man/nvme_mi_port_pcie.2 +++ b/doc/man/nvme_mi_port_pcie.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_port_pcie" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_port_pcie" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_port_pcie \- +struct nvme_mi_port_pcie \- PCIe Port Specific Data .SH SYNOPSIS struct nvme_mi_port_pcie { .br diff --git a/doc/man/nvme_mi_port_smb.2 b/doc/man/nvme_mi_port_smb.2 index e7f3bfa..6549917 100644 --- a/doc/man/nvme_mi_port_smb.2 +++ b/doc/man/nvme_mi_port_smb.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_port_smb" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_port_smb" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_port_smb \- +struct nvme_mi_port_smb \- SMBus Port Specific Data .SH SYNOPSIS struct nvme_mi_port_smb { .br diff --git a/doc/man/nvme_mi_read_ctrl_info.2 b/doc/man/nvme_mi_read_ctrl_info.2 index 790b652..a5ea77f 100644 --- a/doc/man/nvme_mi_read_ctrl_info.2 +++ b/doc/man/nvme_mi_read_ctrl_info.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_read_ctrl_info" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_read_ctrl_info" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_read_ctrl_info \- +struct nvme_mi_read_ctrl_info \- Controller Information Data Structure .SH SYNOPSIS struct nvme_mi_read_ctrl_info { .br diff --git a/doc/man/nvme_mi_read_nvm_ss_info.2 b/doc/man/nvme_mi_read_nvm_ss_info.2 index c063097..093af35 100644 --- a/doc/man/nvme_mi_read_nvm_ss_info.2 +++ b/doc/man/nvme_mi_read_nvm_ss_info.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_read_nvm_ss_info" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_read_nvm_ss_info" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_read_nvm_ss_info \- +struct nvme_mi_read_nvm_ss_info \- NVM Subsystem Information Data Structure .SH SYNOPSIS struct nvme_mi_read_nvm_ss_info { .br diff --git a/doc/man/nvme_mi_read_port_info.2 b/doc/man/nvme_mi_read_port_info.2 index dd634cb..2362d39 100644 --- a/doc/man/nvme_mi_read_port_info.2 +++ b/doc/man/nvme_mi_read_port_info.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_read_port_info" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_read_port_info" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_read_port_info \- +struct nvme_mi_read_port_info \- Port Information Data Structure .SH SYNOPSIS struct nvme_mi_read_port_info { .br diff --git a/doc/man/nvme_mi_read_sc_list.2 b/doc/man/nvme_mi_read_sc_list.2 index f7b9ba4..3680306 100644 --- a/doc/man/nvme_mi_read_sc_list.2 +++ b/doc/man/nvme_mi_read_sc_list.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_read_sc_list" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_read_sc_list" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_read_sc_list \- +struct nvme_mi_read_sc_list \- Management Endpoint Buffer Supported Command List Data Structure .SH SYNOPSIS struct nvme_mi_read_sc_list { .br @@ -16,4 +16,5 @@ struct nvme_mi_read_sc_list { .IP "numcmd" 12 Number of Commands .IP "cmds" 12 -MEB supported Command Data Structure +MEB supported Command Data Structure. +See \fIstruct\fP nvme_mi_osc diff --git a/doc/man/nvme_mi_resp_status.2 b/doc/man/nvme_mi_resp_status.2 new file mode 100644 index 0000000..ab32ff0 --- /dev/null +++ b/doc/man/nvme_mi_resp_status.2 @@ -0,0 +1,120 @@ +.TH "libnvme" 9 "enum nvme_mi_resp_status" "July 2022" "API Manual" LINUX +.SH NAME +enum nvme_mi_resp_status \- values for the response status field +.SH SYNOPSIS +enum nvme_mi_resp_status { +.br +.BI " NVME_MI_RESP_SUCCESS" +, +.br +.br +.BI " NVME_MI_RESP_MPR" +, +.br +.br +.BI " NVME_MI_RESP_INTERNAL_ERR" +, +.br +.br +.BI " NVME_MI_RESP_INVALID_OPCODE" +, +.br +.br +.BI " NVME_MI_RESP_INVALID_PARAM" +, +.br +.br +.BI " NVME_MI_RESP_INVALID_CMD_SIZE" +, +.br +.br +.BI " NVME_MI_RESP_INVALID_INPUT_SIZE" +, +.br +.br +.BI " NVME_MI_RESP_ACCESS_DENIED" +, +.br +.br +.BI " NVME_MI_RESP_VPD_UPDATES_EXCEEDED" +, +.br +.br +.BI " NVME_MI_RESP_PCIE_INACCESSIBLE" +, +.br +.br +.BI " NVME_MI_RESP_MEB_SANITIZED" +, +.br +.br +.BI " NVME_MI_RESP_ENC_SERV_FAILURE" +, +.br +.br +.BI " NVME_MI_RESP_ENC_SERV_XFER_FAILURE" +, +.br +.br +.BI " NVME_MI_RESP_ENC_FAILURE" +, +.br +.br +.BI " NVME_MI_RESP_ENC_XFER_REFUSED" +, +.br +.br +.BI " NVME_MI_RESP_ENC_FUNC_UNSUP" +, +.br +.br +.BI " NVME_MI_RESP_ENC_SERV_UNAVAIL" +, +.br +.br +.BI " NVME_MI_RESP_ENC_DEGRADED" +, +.br +.br +.BI " NVME_MI_RESP_SANITIZE_IN_PROGRESS" + +}; +.SH Constants +.IP "NVME_MI_RESP_SUCCESS" 12 +success +.IP "NVME_MI_RESP_MPR" 12 +More Processing Required +.IP "NVME_MI_RESP_INTERNAL_ERR" 12 +Internal Error +.IP "NVME_MI_RESP_INVALID_OPCODE" 12 +Invalid command opcode +.IP "NVME_MI_RESP_INVALID_PARAM" 12 +Invalid command parameter +.IP "NVME_MI_RESP_INVALID_CMD_SIZE" 12 +Invalid command size +.IP "NVME_MI_RESP_INVALID_INPUT_SIZE" 12 +Invalid command input data size +.IP "NVME_MI_RESP_ACCESS_DENIED" 12 +Access Denied +.IP "NVME_MI_RESP_VPD_UPDATES_EXCEEDED" 12 +More VPD updates than allowed +.IP "NVME_MI_RESP_PCIE_INACCESSIBLE" 12 +PCIe functionality currently unavailable +.IP "NVME_MI_RESP_MEB_SANITIZED" 12 +MEB has been cleared due to sanitize +.IP "NVME_MI_RESP_ENC_SERV_FAILURE" 12 +Enclosure services process failed +.IP "NVME_MI_RESP_ENC_SERV_XFER_FAILURE" 12 +Transfer with enclosure services failed +.IP "NVME_MI_RESP_ENC_FAILURE" 12 +Unreoverable enclosure failure +.IP "NVME_MI_RESP_ENC_XFER_REFUSED" 12 +Enclosure services transfer refused +.IP "NVME_MI_RESP_ENC_FUNC_UNSUP" 12 +Unsupported enclosure services function +.IP "NVME_MI_RESP_ENC_SERV_UNAVAIL" 12 +Enclosure services unavailable +.IP "NVME_MI_RESP_ENC_DEGRADED" 12 +Noncritical failure detected by enc. services +.IP "NVME_MI_RESP_SANITIZE_IN_PROGRESS" 12 +Command prohibited during sanitize diff --git a/doc/man/nvme_mi_vpd_hdr.2 b/doc/man/nvme_mi_vpd_hdr.2 index f3b646d..9cd18a5 100644 --- a/doc/man/nvme_mi_vpd_hdr.2 +++ b/doc/man/nvme_mi_vpd_hdr.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_vpd_hdr" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_vpd_hdr" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_vpd_hdr \- +struct nvme_mi_vpd_hdr \- Vital Product Data Common Header .SH SYNOPSIS struct nvme_mi_vpd_hdr { .br diff --git a/doc/man/nvme_mi_vpd_mr_common.2 b/doc/man/nvme_mi_vpd_mr_common.2 index 7e8d7a2..6862437 100644 --- a/doc/man/nvme_mi_vpd_mr_common.2 +++ b/doc/man/nvme_mi_vpd_mr_common.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_vpd_mr_common" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_vpd_mr_common" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_vpd_mr_common \- +struct nvme_mi_vpd_mr_common \- NVMe MultiRecord Area .SH SYNOPSIS struct nvme_mi_vpd_mr_common { .br diff --git a/doc/man/nvme_mi_vpd_mra.2 b/doc/man/nvme_mi_vpd_mra.2 index 6658d62..10a4215 100644 --- a/doc/man/nvme_mi_vpd_mra.2 +++ b/doc/man/nvme_mi_vpd_mra.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_vpd_mra" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_vpd_mra" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_vpd_mra \- +struct nvme_mi_vpd_mra \- NVMe MultiRecord Area .SH SYNOPSIS struct nvme_mi_vpd_mra { .br @@ -58,7 +58,7 @@ Maximum 3.3 V Power Supply Requirements .IP "rsvd17" 12 Reserved .IP "m33vapsr" 12 -Maximum 3.3 V aux Power Supply Requirements +Maximum 3.3 Vi aux Power Supply Requirements .IP "i5vapsr" 12 Initial 5 V Power Supply Requirements .IP "m5vapsr" 12 diff --git a/doc/man/nvme_mi_vpd_ppmra.2 b/doc/man/nvme_mi_vpd_ppmra.2 index 7e45525..0761806 100644 --- a/doc/man/nvme_mi_vpd_ppmra.2 +++ b/doc/man/nvme_mi_vpd_ppmra.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_vpd_ppmra" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_vpd_ppmra" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_vpd_ppmra \- +struct nvme_mi_vpd_ppmra \- NVMe PCIe Port MultiRecord Area .SH SYNOPSIS struct nvme_mi_vpd_ppmra { .br diff --git a/doc/man/nvme_mi_vpd_telem.2 b/doc/man/nvme_mi_vpd_telem.2 index f7a754b..a9e4e65 100644 --- a/doc/man/nvme_mi_vpd_telem.2 +++ b/doc/man/nvme_mi_vpd_telem.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_vpd_telem" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_vpd_telem" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_vpd_telem \- +struct nvme_mi_vpd_telem \- Vital Product Data Element Descriptor .SH SYNOPSIS struct nvme_mi_vpd_telem { .br diff --git a/doc/man/nvme_mi_vpd_tra.2 b/doc/man/nvme_mi_vpd_tra.2 index ed56dcd..6c53807 100644 --- a/doc/man/nvme_mi_vpd_tra.2 +++ b/doc/man/nvme_mi_vpd_tra.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_mi_vpd_tra" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_mi_vpd_tra" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_mi_vpd_tra \- +struct nvme_mi_vpd_tra \- Vital Product Data Topology MultiRecord .SH SYNOPSIS struct nvme_mi_vpd_tra { .br diff --git a/doc/man/nvme_namespace_attach_ctrls.2 b/doc/man/nvme_namespace_attach_ctrls.2 index 22657bd..2459f68 100644 --- a/doc/man/nvme_namespace_attach_ctrls.2 +++ b/doc/man/nvme_namespace_attach_ctrls.2 @@ -1,4 +1,4 @@ -.TH "nvme_namespace_attach_ctrls" 9 "nvme_namespace_attach_ctrls" "April 2022" "libnvme API manual" LINUX +.TH "nvme_namespace_attach_ctrls" 9 "nvme_namespace_attach_ctrls" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_namespace_attach_ctrls \- Attach namespace to controller(s) .SH SYNOPSIS diff --git a/doc/man/nvme_namespace_detach_ctrls.2 b/doc/man/nvme_namespace_detach_ctrls.2 index 2d18cc5..6bfa91f 100644 --- a/doc/man/nvme_namespace_detach_ctrls.2 +++ b/doc/man/nvme_namespace_detach_ctrls.2 @@ -1,4 +1,4 @@ -.TH "nvme_namespace_detach_ctrls" 9 "nvme_namespace_detach_ctrls" "April 2022" "libnvme API manual" LINUX +.TH "nvme_namespace_detach_ctrls" 9 "nvme_namespace_detach_ctrls" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_namespace_detach_ctrls \- Detach namespace from controller(s) .SH SYNOPSIS diff --git a/doc/man/nvme_namespace_filter.2 b/doc/man/nvme_namespace_filter.2 index 5536b95..642e183 100644 --- a/doc/man/nvme_namespace_filter.2 +++ b/doc/man/nvme_namespace_filter.2 @@ -1,4 +1,4 @@ -.TH "nvme_namespace_filter" 9 "nvme_namespace_filter" "April 2022" "libnvme API manual" LINUX +.TH "nvme_namespace_filter" 9 "nvme_namespace_filter" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_namespace_filter \- Filter for namespaces .SH SYNOPSIS diff --git a/doc/man/nvme_namespace_first_path.2 b/doc/man/nvme_namespace_first_path.2 index faaace8..29f6806 100644 --- a/doc/man/nvme_namespace_first_path.2 +++ b/doc/man/nvme_namespace_first_path.2 @@ -1,4 +1,4 @@ -.TH "nvme_namespace_first_path" 9 "nvme_namespace_first_path" "April 2022" "libnvme API manual" LINUX +.TH "nvme_namespace_first_path" 9 "nvme_namespace_first_path" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_namespace_first_path \- Start path iterator .SH SYNOPSIS diff --git a/doc/man/nvme_namespace_for_each_path.2 b/doc/man/nvme_namespace_for_each_path.2 index c86bb59..eaf0d6d 100644 --- a/doc/man/nvme_namespace_for_each_path.2 +++ b/doc/man/nvme_namespace_for_each_path.2 @@ -1,12 +1,12 @@ -.TH "nvme_namespace_for_each_path" 9 "nvme_namespace_for_each_path" "April 2022" "libnvme API manual" LINUX +.TH "nvme_namespace_for_each_path" 9 "nvme_namespace_for_each_path" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_namespace_for_each_path \- Traverse paths .SH SYNOPSIS .B "nvme_namespace_for_each_path -.BI "(c " "," +.BI "(n " "," .BI "p " ");" .SH ARGUMENTS -.IP "c" 12 --- undescribed -- +.IP "n" 12 +Namespace instance .IP "p" 12 \fInvme_path_t\fP object diff --git a/doc/man/nvme_namespace_for_each_path_safe.2 b/doc/man/nvme_namespace_for_each_path_safe.2 index 9202a27..d6bc5ff 100644 --- a/doc/man/nvme_namespace_for_each_path_safe.2 +++ b/doc/man/nvme_namespace_for_each_path_safe.2 @@ -1,4 +1,4 @@ -.TH "nvme_namespace_for_each_path_safe" 9 "nvme_namespace_for_each_path_safe" "April 2022" "libnvme API manual" LINUX +.TH "nvme_namespace_for_each_path_safe" 9 "nvme_namespace_for_each_path_safe" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_namespace_for_each_path_safe \- Traverse paths .SH SYNOPSIS @@ -8,7 +8,7 @@ nvme_namespace_for_each_path_safe \- Traverse paths .BI "_p " ");" .SH ARGUMENTS .IP "n" 12 --- undescribed -- +Namespace instance .IP "p" 12 \fInvme_path_t\fP object .IP "_p" 12 diff --git a/doc/man/nvme_namespace_next_path.2 b/doc/man/nvme_namespace_next_path.2 index a380df3..b367fac 100644 --- a/doc/man/nvme_namespace_next_path.2 +++ b/doc/man/nvme_namespace_next_path.2 @@ -1,13 +1,13 @@ -.TH "nvme_namespace_next_path" 9 "nvme_namespace_next_path" "April 2022" "libnvme API manual" LINUX +.TH "nvme_namespace_next_path" 9 "nvme_namespace_next_path" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_namespace_next_path \- Next path iterator .SH SYNOPSIS .B "nvme_path_t" nvme_namespace_next_path -.BI "(nvme_ns_t c " "," +.BI "(nvme_ns_t ns " "," .BI "nvme_path_t p " ");" .SH ARGUMENTS -.IP "c" 12 --- undescribed -- +.IP "ns" 12 +Namespace instance .IP "p" 12 Previous \fInvme_path_t\fP object of an \fIns\fP iterator .SH "RETURN" diff --git a/doc/man/nvme_nd_ns_fpi.2 b/doc/man/nvme_nd_ns_fpi.2 index b3dfa5b..0675d12 100644 --- a/doc/man/nvme_nd_ns_fpi.2 +++ b/doc/man/nvme_nd_ns_fpi.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_nd_ns_fpi" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_nd_ns_fpi" "July 2022" "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 diff --git a/doc/man/nvme_next_host.2 b/doc/man/nvme_next_host.2 index 39cbf31..b53781c 100644 --- a/doc/man/nvme_next_host.2 +++ b/doc/man/nvme_next_host.2 @@ -1,4 +1,4 @@ -.TH "nvme_next_host" 9 "nvme_next_host" "April 2022" "libnvme API manual" LINUX +.TH "nvme_next_host" 9 "nvme_next_host" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_next_host \- Next host iterator .SH SYNOPSIS diff --git a/doc/man/nvme_next_subsystem.2 b/doc/man/nvme_next_subsystem.2 index d6a0b32..000f34d 100644 --- a/doc/man/nvme_next_subsystem.2 +++ b/doc/man/nvme_next_subsystem.2 @@ -1,4 +1,4 @@ -.TH "nvme_next_subsystem" 9 "nvme_next_subsystem" "April 2022" "libnvme API manual" LINUX +.TH "nvme_next_subsystem" 9 "nvme_next_subsystem" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_next_subsystem \- Next subsystem iterator .SH SYNOPSIS diff --git a/doc/man/nvme_ns_attach.2 b/doc/man/nvme_ns_attach.2 index 806998c..efdd161 100644 --- a/doc/man/nvme_ns_attach.2 +++ b/doc/man/nvme_ns_attach.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_attach" 9 "nvme_ns_attach" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_attach" 9 "nvme_ns_attach" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_attach \- Attach or detach namespace to controller(s) .SH SYNOPSIS @@ -7,3 +7,6 @@ nvme_ns_attach \- Attach or detach namespace to controller(s) .SH ARGUMENTS .IP "args" 12 \fIstruct nvme_ns_attach_args\fP Argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_ns_attach_args.2 b/doc/man/nvme_ns_attach_args.2 deleted file mode 100644 index 00f2d14..0000000 --- a/doc/man/nvme_ns_attach_args.2 +++ /dev/null @@ -1,39 +0,0 @@ -.TH "libnvme" 9 "struct nvme_ns_attach_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_ns_attach_args \- Arguments for Nvme Namespace Management command -.SH SYNOPSIS -struct nvme_ns_attach_args { -.br -.BI " __u32 *result;" -.br -.BI " struct nvme_ctrl_list *ctrlist;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " __u32 nsid;" -.br -.BI " enum nvme_ns_attach_sel sel;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -NVMe command result -.IP "ctrlist" 12 -Controller list to modify attachment state of nsid -.IP "args_size" 12 -Size of \fIstruct nvme_ns_attach_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace ID to execute attach selection -.IP "sel" 12 -Attachment selection, see \fIenum nvme_ns_attach_sel\fP diff --git a/doc/man/nvme_ns_attach_ctrls.2 b/doc/man/nvme_ns_attach_ctrls.2 index b28ddb3..1c57b4d 100644 --- a/doc/man/nvme_ns_attach_ctrls.2 +++ b/doc/man/nvme_ns_attach_ctrls.2 @@ -1,6 +1,6 @@ -.TH "nvme_ns_attach_ctrls" 9 "nvme_ns_attach_ctrls" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_attach_ctrls" 9 "nvme_ns_attach_ctrls" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_ns_attach_ctrls \- +nvme_ns_attach_ctrls \- Attach namespace to controllers .SH SYNOPSIS .B "int" nvme_ns_attach_ctrls .BI "(int fd " "," @@ -13,3 +13,6 @@ File descriptor of nvme device Namespace ID to attach .IP "ctrlist" 12 Controller list to modify attachment state of nsid +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_ns_attach_sel.2 b/doc/man/nvme_ns_attach_sel.2 index b3e0386..1dafaf2 100644 --- a/doc/man/nvme_ns_attach_sel.2 +++ b/doc/man/nvme_ns_attach_sel.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_ns_attach_sel" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_ns_attach_sel" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_ns_attach_sel \- +enum nvme_ns_attach_sel \- Namespace Attachment - Select .SH SYNOPSIS enum nvme_ns_attach_sel { .br diff --git a/doc/man/nvme_ns_compare.2 b/doc/man/nvme_ns_compare.2 index 0c1d267..4ae2020 100644 --- a/doc/man/nvme_ns_compare.2 +++ b/doc/man/nvme_ns_compare.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_compare" 9 "nvme_ns_compare" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_compare" 9 "nvme_ns_compare" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_compare \- Compare data on a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_detach_ctrls.2 b/doc/man/nvme_ns_detach_ctrls.2 index 28ea6f3..c505317 100644 --- a/doc/man/nvme_ns_detach_ctrls.2 +++ b/doc/man/nvme_ns_detach_ctrls.2 @@ -1,6 +1,6 @@ -.TH "nvme_ns_detach_ctrls" 9 "nvme_ns_detach_ctrls" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_detach_ctrls" 9 "nvme_ns_detach_ctrls" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_ns_detach_ctrls \- +nvme_ns_detach_ctrls \- Detach namespace from controllers .SH SYNOPSIS .B "int" nvme_ns_detach_ctrls .BI "(int fd " "," @@ -13,3 +13,6 @@ File descriptor of nvme device Namespace ID to detach .IP "ctrlist" 12 Controller list to modify attachment state of nsid +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_ns_flush.2 b/doc/man/nvme_ns_flush.2 index c7cab3a..18962c7 100644 --- a/doc/man/nvme_ns_flush.2 +++ b/doc/man/nvme_ns_flush.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_flush" 9 "nvme_ns_flush" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_flush" 9 "nvme_ns_flush" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_flush \- Flush data to a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_csi.2 b/doc/man/nvme_ns_get_csi.2 index b8ba92f..1651f0b 100644 --- a/doc/man/nvme_ns_get_csi.2 +++ b/doc/man/nvme_ns_get_csi.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_csi" 9 "nvme_ns_get_csi" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_csi" 9 "nvme_ns_get_csi" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_csi \- Command set identifier of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_ctrl.2 b/doc/man/nvme_ns_get_ctrl.2 index fb3467c..37406fb 100644 --- a/doc/man/nvme_ns_get_ctrl.2 +++ b/doc/man/nvme_ns_get_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_ctrl" 9 "nvme_ns_get_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_ctrl" 9 "nvme_ns_get_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_ctrl \- &nvme_ctrl_t of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_fd.2 b/doc/man/nvme_ns_get_fd.2 index 95c199e..be3e3b0 100644 --- a/doc/man/nvme_ns_get_fd.2 +++ b/doc/man/nvme_ns_get_fd.2 @@ -1,6 +1,6 @@ -.TH "nvme_ns_get_fd" 9 "nvme_ns_get_fd" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_fd" 9 "nvme_ns_get_fd" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_ns_get_fd \- Get associated filedescriptor +nvme_ns_get_fd \- Get associated file descriptor .SH SYNOPSIS .B "int" nvme_ns_get_fd .BI "(nvme_ns_t n " ");" diff --git a/doc/man/nvme_ns_get_firmware.2 b/doc/man/nvme_ns_get_firmware.2 index cc721c7..2905572 100644 --- a/doc/man/nvme_ns_get_firmware.2 +++ b/doc/man/nvme_ns_get_firmware.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_firmware" 9 "nvme_ns_get_firmware" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_firmware" 9 "nvme_ns_get_firmware" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_firmware \- Firmware string of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_generic_name.2 b/doc/man/nvme_ns_get_generic_name.2 index 58176ca..524162b 100644 --- a/doc/man/nvme_ns_get_generic_name.2 +++ b/doc/man/nvme_ns_get_generic_name.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_generic_name" 9 "nvme_ns_get_generic_name" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_generic_name" 9 "nvme_ns_get_generic_name" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_generic_name \- Returns name of generic namespace chardev. .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_lba_count.2 b/doc/man/nvme_ns_get_lba_count.2 index 7d3c172..329da0d 100644 --- a/doc/man/nvme_ns_get_lba_count.2 +++ b/doc/man/nvme_ns_get_lba_count.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_lba_count" 9 "nvme_ns_get_lba_count" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_lba_count" 9 "nvme_ns_get_lba_count" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_lba_count \- LBA count of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_lba_size.2 b/doc/man/nvme_ns_get_lba_size.2 index 62f3850..2641508 100644 --- a/doc/man/nvme_ns_get_lba_size.2 +++ b/doc/man/nvme_ns_get_lba_size.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_lba_size" 9 "nvme_ns_get_lba_size" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_lba_size" 9 "nvme_ns_get_lba_size" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_lba_size \- LBA size of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_lba_util.2 b/doc/man/nvme_ns_get_lba_util.2 index 52eac40..55041d4 100644 --- a/doc/man/nvme_ns_get_lba_util.2 +++ b/doc/man/nvme_ns_get_lba_util.2 @@ -1,6 +1,6 @@ -.TH "nvme_ns_get_lba_util" 9 "nvme_ns_get_lba_util" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_lba_util" 9 "nvme_ns_get_lba_util" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_ns_get_lba_util \- LBA utilisation of a namespace +nvme_ns_get_lba_util \- LBA utilization of a namespace .SH SYNOPSIS .B "uint64_t" nvme_ns_get_lba_util .BI "(nvme_ns_t n " ");" @@ -8,4 +8,4 @@ nvme_ns_get_lba_util \- LBA utilisation of a namespace .IP "n" 12 Namespace instance .SH "RETURN" -LBA utilisation of \fIn\fP +LBA utilization of \fIn\fP diff --git a/doc/man/nvme_ns_get_meta_size.2 b/doc/man/nvme_ns_get_meta_size.2 index 7cd756a..c067cf0 100644 --- a/doc/man/nvme_ns_get_meta_size.2 +++ b/doc/man/nvme_ns_get_meta_size.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_meta_size" 9 "nvme_ns_get_meta_size" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_meta_size" 9 "nvme_ns_get_meta_size" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_meta_size \- Metadata size of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_model.2 b/doc/man/nvme_ns_get_model.2 index 3ca02f4..bfe75a9 100644 --- a/doc/man/nvme_ns_get_model.2 +++ b/doc/man/nvme_ns_get_model.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_model" 9 "nvme_ns_get_model" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_model" 9 "nvme_ns_get_model" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_model \- Model of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_name.2 b/doc/man/nvme_ns_get_name.2 index d4cf500..e4497cd 100644 --- a/doc/man/nvme_ns_get_name.2 +++ b/doc/man/nvme_ns_get_name.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_name" 9 "nvme_ns_get_name" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_name" 9 "nvme_ns_get_name" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_name \- sysfs name of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_nguid.2 b/doc/man/nvme_ns_get_nguid.2 index 43bb47c..e726036 100644 --- a/doc/man/nvme_ns_get_nguid.2 +++ b/doc/man/nvme_ns_get_nguid.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_nguid" 9 "nvme_ns_get_nguid" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_nguid" 9 "nvme_ns_get_nguid" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_nguid \- 128-bit nguid of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_nsid.2 b/doc/man/nvme_ns_get_nsid.2 index 2904471..004c7e8 100644 --- a/doc/man/nvme_ns_get_nsid.2 +++ b/doc/man/nvme_ns_get_nsid.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_nsid" 9 "nvme_ns_get_nsid" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_nsid" 9 "nvme_ns_get_nsid" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_nsid \- NSID of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_serial.2 b/doc/man/nvme_ns_get_serial.2 index cafedd7..c7f8ab1 100644 --- a/doc/man/nvme_ns_get_serial.2 +++ b/doc/man/nvme_ns_get_serial.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_serial" 9 "nvme_ns_get_serial" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_serial" 9 "nvme_ns_get_serial" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_serial \- Serial number of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_subsystem.2 b/doc/man/nvme_ns_get_subsystem.2 index b9404ad..f51f9f9 100644 --- a/doc/man/nvme_ns_get_subsystem.2 +++ b/doc/man/nvme_ns_get_subsystem.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_subsystem" 9 "nvme_ns_get_subsystem" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_subsystem" 9 "nvme_ns_get_subsystem" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_subsystem \- &nvme_subsystem_t of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_sysfs_dir.2 b/doc/man/nvme_ns_get_sysfs_dir.2 index 5ff53f5..60d452f 100644 --- a/doc/man/nvme_ns_get_sysfs_dir.2 +++ b/doc/man/nvme_ns_get_sysfs_dir.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_sysfs_dir" 9 "nvme_ns_get_sysfs_dir" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_sysfs_dir" 9 "nvme_ns_get_sysfs_dir" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_sysfs_dir \- sysfs directory of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_get_uuid.2 b/doc/man/nvme_ns_get_uuid.2 index ee0c607..b9f3991 100644 --- a/doc/man/nvme_ns_get_uuid.2 +++ b/doc/man/nvme_ns_get_uuid.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_get_uuid" 9 "nvme_ns_get_uuid" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_get_uuid" 9 "nvme_ns_get_uuid" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_get_uuid \- UUID of a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_id_desc.2 b/doc/man/nvme_ns_id_desc.2 index 2116046..094618c 100644 --- a/doc/man/nvme_ns_id_desc.2 +++ b/doc/man/nvme_ns_id_desc.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_ns_id_desc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_ns_id_desc" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_ns_id_desc \- +struct nvme_ns_id_desc \- Namespace identifier type descriptor .SH SYNOPSIS struct nvme_ns_id_desc { .br diff --git a/doc/man/nvme_ns_id_desc_nidt.2 b/doc/man/nvme_ns_id_desc_nidt.2 index eb399b1..9c64b89 100644 --- a/doc/man/nvme_ns_id_desc_nidt.2 +++ b/doc/man/nvme_ns_id_desc_nidt.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_ns_id_desc_nidt" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_ns_id_desc_nidt" "July 2022" "API Manual" LINUX .SH NAME enum nvme_ns_id_desc_nidt \- Known namespace identifier types .SH SYNOPSIS @@ -30,4 +30,4 @@ contains a copy of the NGUID field in struct nvme_id_ns.nguid. The NID field contains a 128-bit Universally Unique Identifier (UUID) as specified in RFC 4122. .IP "NVME_NIDT_CSI" 12 -The NID field contains the command set indentifier. +The NID field contains the command set identifier. diff --git a/doc/man/nvme_ns_identify.2 b/doc/man/nvme_ns_identify.2 index 0aa1e53..487e56a 100644 --- a/doc/man/nvme_ns_identify.2 +++ b/doc/man/nvme_ns_identify.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_identify" 9 "nvme_ns_identify" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_identify" 9 "nvme_ns_identify" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_identify \- Issue an 'identify namespace' command .SH SYNOPSIS diff --git a/doc/man/nvme_ns_identify_descs.2 b/doc/man/nvme_ns_identify_descs.2 index e7a8e68..9a1e2c6 100644 --- a/doc/man/nvme_ns_identify_descs.2 +++ b/doc/man/nvme_ns_identify_descs.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_identify_descs" 9 "nvme_ns_identify_descs" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_identify_descs" 9 "nvme_ns_identify_descs" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_identify_descs \- Issue an 'identify descriptors' command .SH SYNOPSIS diff --git a/doc/man/nvme_ns_list.2 b/doc/man/nvme_ns_list.2 index 92943a0..f8c535b 100644 --- a/doc/man/nvme_ns_list.2 +++ b/doc/man/nvme_ns_list.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_ns_list" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_ns_list" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_ns_list \- +struct nvme_ns_list \- Namespace List .SH SYNOPSIS struct nvme_ns_list { .br diff --git a/doc/man/nvme_ns_metadata_type.2 b/doc/man/nvme_ns_metadata_type.2 index 7de5c2d..50a19f0 100644 --- a/doc/man/nvme_ns_metadata_type.2 +++ b/doc/man/nvme_ns_metadata_type.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_ns_metadata_type" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_ns_metadata_type" "July 2022" "API Manual" LINUX .SH NAME enum nvme_ns_metadata_type \- Namespace Metadata Element Types .SH SYNOPSIS @@ -21,7 +21,7 @@ enum nvme_ns_metadata_type { }; .SH Constants .IP "NVME_NS_METADATA_OS_NS_NAME" 12 -Name of the namespace in the the +Name of the namespace in the operating system .IP "NVME_NS_METADATA_PRE_BOOT_NS_NAME" 12 Name of the namespace in the pre-boot diff --git a/doc/man/nvme_ns_mgmt.2 b/doc/man/nvme_ns_mgmt.2 index 8916910..4bafe02 100644 --- a/doc/man/nvme_ns_mgmt.2 +++ b/doc/man/nvme_ns_mgmt.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_mgmt" 9 "nvme_ns_mgmt" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_mgmt" 9 "nvme_ns_mgmt" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_mgmt \- Issue a Namespace management command .SH SYNOPSIS @@ -7,3 +7,6 @@ nvme_ns_mgmt \- Issue a Namespace management command .SH ARGUMENTS .IP "args" 12 \fIstruct nvme_ns_mgmt_args\fP Argument structure +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_ns_mgmt_args.2 b/doc/man/nvme_ns_mgmt_args.2 deleted file mode 100644 index 9231c78..0000000 --- a/doc/man/nvme_ns_mgmt_args.2 +++ /dev/null @@ -1,43 +0,0 @@ -.TH "libnvme" 9 "struct nvme_ns_mgmt_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_ns_mgmt_args \- Arguments for NVMe Namespace Management command -.SH SYNOPSIS -struct nvme_ns_mgmt_args { -.br -.BI " __u32 *result;" -.br -.BI " struct nvme_id_ns *ns;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " __u32 nsid;" -.br -.BI " enum nvme_ns_mgmt_sel sel;" -.br -.BI " __u8 csi;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -NVMe command result -.IP "ns" 12 -Namespace identication descriptors -.IP "args_size" 12 -Size of \fIstruct nvme_ns_mgmt_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace identifier -.IP "sel" 12 -Type of management operation to perform -.IP "csi" 12 -Command Set Identifier diff --git a/doc/man/nvme_ns_mgmt_create.2 b/doc/man/nvme_ns_mgmt_create.2 index 479d146..55ec80a 100644 --- a/doc/man/nvme_ns_mgmt_create.2 +++ b/doc/man/nvme_ns_mgmt_create.2 @@ -1,6 +1,6 @@ -.TH "nvme_ns_mgmt_create" 9 "nvme_ns_mgmt_create" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_mgmt_create" 9 "nvme_ns_mgmt_create" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_ns_mgmt_create \- +nvme_ns_mgmt_create \- Create a non attached namespace .SH SYNOPSIS .B "int" nvme_ns_mgmt_create .BI "(int fd " "," @@ -16,7 +16,7 @@ Namespace identification that defines ns creation parameters .IP "nsid" 12 On success, set to the namespace id that was created .IP "timeout" 12 -Overide the default timeout to this value in milliseconds; +Override the default timeout to this value in milliseconds; set to 0 to use the system default. .IP "csi" 12 Command Set Identifier diff --git a/doc/man/nvme_ns_mgmt_delete.2 b/doc/man/nvme_ns_mgmt_delete.2 index dcbf3f0..a05b189 100644 --- a/doc/man/nvme_ns_mgmt_delete.2 +++ b/doc/man/nvme_ns_mgmt_delete.2 @@ -1,6 +1,6 @@ -.TH "nvme_ns_mgmt_delete" 9 "nvme_ns_mgmt_delete" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_mgmt_delete" 9 "nvme_ns_mgmt_delete" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_ns_mgmt_delete \- +nvme_ns_mgmt_delete \- Delete a non attached namespace .SH SYNOPSIS .B "int" nvme_ns_mgmt_delete .BI "(int fd " "," diff --git a/doc/man/nvme_ns_mgmt_sel.2 b/doc/man/nvme_ns_mgmt_sel.2 index 8683f3b..6dc24bc 100644 --- a/doc/man/nvme_ns_mgmt_sel.2 +++ b/doc/man/nvme_ns_mgmt_sel.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_ns_mgmt_sel" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_ns_mgmt_sel" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_ns_mgmt_sel \- +enum nvme_ns_mgmt_sel \- Namespace Management - Select .SH SYNOPSIS enum nvme_ns_mgmt_sel { .br diff --git a/doc/man/nvme_ns_read.2 b/doc/man/nvme_ns_read.2 index b6d8441..455c691 100644 --- a/doc/man/nvme_ns_read.2 +++ b/doc/man/nvme_ns_read.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_read" 9 "nvme_ns_read" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_read" 9 "nvme_ns_read" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_read \- Read from a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_rescan.2 b/doc/man/nvme_ns_rescan.2 index c0334d3..7e7b4e5 100644 --- a/doc/man/nvme_ns_rescan.2 +++ b/doc/man/nvme_ns_rescan.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_rescan" 9 "nvme_ns_rescan" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_rescan" 9 "nvme_ns_rescan" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_rescan \- Initiate a controller rescan .SH SYNOPSIS diff --git a/doc/man/nvme_ns_verify.2 b/doc/man/nvme_ns_verify.2 index 1f669ad..93c5115 100644 --- a/doc/man/nvme_ns_verify.2 +++ b/doc/man/nvme_ns_verify.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_verify" 9 "nvme_ns_verify" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_verify" 9 "nvme_ns_verify" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_verify \- Verify data on a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_write.2 b/doc/man/nvme_ns_write.2 index 132ea2c..fbf2fff 100644 --- a/doc/man/nvme_ns_write.2 +++ b/doc/man/nvme_ns_write.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_write" 9 "nvme_ns_write" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_write" 9 "nvme_ns_write" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_write \- Write to a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_ns_write_protect_cfg.2 b/doc/man/nvme_ns_write_protect_cfg.2 index 5a8dc11..c2c9dd1 100644 --- a/doc/man/nvme_ns_write_protect_cfg.2 +++ b/doc/man/nvme_ns_write_protect_cfg.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_ns_write_protect_cfg" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_ns_write_protect_cfg" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_ns_write_protect_cfg \- +enum nvme_ns_write_protect_cfg \- Write Protection - Write Protection State .SH SYNOPSIS enum nvme_ns_write_protect_cfg { .br diff --git a/doc/man/nvme_ns_write_uncorrectable.2 b/doc/man/nvme_ns_write_uncorrectable.2 index b6de816..b0ee949 100644 --- a/doc/man/nvme_ns_write_uncorrectable.2 +++ b/doc/man/nvme_ns_write_uncorrectable.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_write_uncorrectable" 9 "nvme_ns_write_uncorrectable" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_write_uncorrectable" 9 "nvme_ns_write_uncorrectable" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_write_uncorrectable \- Issus a 'write uncorrectable' command .SH SYNOPSIS diff --git a/doc/man/nvme_ns_write_zeros.2 b/doc/man/nvme_ns_write_zeros.2 index ee2c2d1..2be6798 100644 --- a/doc/man/nvme_ns_write_zeros.2 +++ b/doc/man/nvme_ns_write_zeros.2 @@ -1,4 +1,4 @@ -.TH "nvme_ns_write_zeros" 9 "nvme_ns_write_zeros" "April 2022" "libnvme API manual" LINUX +.TH "nvme_ns_write_zeros" 9 "nvme_ns_write_zeros" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_ns_write_zeros \- Write zeros to a namespace .SH SYNOPSIS diff --git a/doc/man/nvme_nss_hw_err_event.2 b/doc/man/nvme_nss_hw_err_event.2 index a64966e..78d3cba 100644 --- a/doc/man/nvme_nss_hw_err_event.2 +++ b/doc/man/nvme_nss_hw_err_event.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_nss_hw_err_event" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_nss_hw_err_event" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_nss_hw_err_event \- +struct nvme_nss_hw_err_event \- NVM Subsystem Hardware Error Event .SH SYNOPSIS struct nvme_nss_hw_err_event { .br diff --git a/doc/man/nvme_nvm_id_ns.2 b/doc/man/nvme_nvm_id_ns.2 index 13dae13..3809cb7 100644 --- a/doc/man/nvme_nvm_id_ns.2 +++ b/doc/man/nvme_nvm_id_ns.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_nvm_id_ns" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_nvm_id_ns" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_nvm_id_ns \- +struct nvme_nvm_id_ns \- NVME Command Set I/O Command Set Specific Identify Namespace Data Structure .SH SYNOPSIS struct nvme_nvm_id_ns { .br diff --git a/doc/man/nvme_nvm_id_ns_elbaf.2 b/doc/man/nvme_nvm_id_ns_elbaf.2 new file mode 100644 index 0000000..4a48aff --- /dev/null +++ b/doc/man/nvme_nvm_id_ns_elbaf.2 @@ -0,0 +1,20 @@ +.TH "libnvme" 9 "enum nvme_nvm_id_ns_elbaf" "July 2022" "API Manual" LINUX +.SH NAME +enum nvme_nvm_id_ns_elbaf \- This field indicates the extended LBA format +.SH SYNOPSIS +enum nvme_nvm_id_ns_elbaf { +.br +.BI " NVME_NVM_ELBAF_STS_MASK" +, +.br +.br +.BI " NVME_NVM_ELBAF_PIF_MASK" + +}; +.SH Constants +.IP "NVME_NVM_ELBAF_STS_MASK" 12 +Mask to get the storage tag size used to determine +the variable-sized storage tag/reference tag fields +.IP "NVME_NVM_ELBAF_PIF_MASK" 12 +Mask to get the protection information format for +the extended LBA format. diff --git a/doc/man/nvme_nvm_identify_ctrl.2 b/doc/man/nvme_nvm_identify_ctrl.2 index 313368a..0f36e26 100644 --- a/doc/man/nvme_nvm_identify_ctrl.2 +++ b/doc/man/nvme_nvm_identify_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_nvm_identify_ctrl" 9 "nvme_nvm_identify_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_nvm_identify_ctrl" 9 "nvme_nvm_identify_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_nvm_identify_ctrl \- Identify controller data .SH SYNOPSIS diff --git a/doc/man/nvme_nvmeset_pl_status.2 b/doc/man/nvme_nvmeset_pl_status.2 index 3c224b4..7a20f84 100644 --- a/doc/man/nvme_nvmeset_pl_status.2 +++ b/doc/man/nvme_nvmeset_pl_status.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_nvmeset_pl_status" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_nvmeset_pl_status" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_nvmeset_pl_status \- +enum nvme_nvmeset_pl_status \- Predictable Latency Per NVM Set Log - Status .SH SYNOPSIS enum nvme_nvmeset_pl_status { .br @@ -17,5 +17,8 @@ enum nvme_nvmeset_pl_status { }; .SH Constants .IP "NVME_NVMSET_PL_STATUS_DISABLED" 12 +Not used (Predictable Latency Mode not enabled) .IP "NVME_NVMSET_PL_STATUS_DTWIN" 12 +Deterministic Window (DTWIN) .IP "NVME_NVMSET_PL_STATUS_NDWIN" 12 +Non-Deterministic Window (NDWIN) diff --git a/doc/man/nvme_nvmset_attr.2 b/doc/man/nvme_nvmset_attr.2 index 450378c..fed79bf 100644 --- a/doc/man/nvme_nvmset_attr.2 +++ b/doc/man/nvme_nvmset_attr.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_nvmset_attr" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_nvmset_attr" "July 2022" "API Manual" LINUX .SH NAME struct nvme_nvmset_attr \- NVM Set Attributes Entry .SH SYNOPSIS diff --git a/doc/man/nvme_nvmset_pl_events.2 b/doc/man/nvme_nvmset_pl_events.2 index 36fe819..af53eec 100644 --- a/doc/man/nvme_nvmset_pl_events.2 +++ b/doc/man/nvme_nvmset_pl_events.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_nvmset_pl_events" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_nvmset_pl_events" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_nvmset_pl_events \- +enum nvme_nvmset_pl_events \- Predictable Latency Per NVM Set Log - Event Type .SH SYNOPSIS enum nvme_nvmset_pl_events { .br @@ -25,7 +25,16 @@ enum nvme_nvmset_pl_events { }; .SH Constants .IP "NVME_NVMSET_PL_EVENT_DTWIN_READ_WARN" 12 +DTWIN Reads Warning .IP "NVME_NVMSET_PL_EVENT_DTWIN_WRITE_WARN" 12 +DTWIN Writes Warning .IP "NVME_NVMSET_PL_EVENT_DTWIN_TIME_WARN" 12 +DTWIN Time Warning .IP "NVME_NVMSET_PL_EVENT_DTWIN_EXCEEDED" 12 +Autonomous transition from DTWIN +to NDWIN due to typical or +maximum value exceeded .IP "NVME_NVMSET_PL_EVENT_DTWIN_EXCURSION" 12 +Autonomous transition from DTWIN +to NDWIN due to Deterministic +Excursion diff --git a/doc/man/nvme_nvmset_predictable_lat_log.2 b/doc/man/nvme_nvmset_predictable_lat_log.2 index 172bdce..6e12c93 100644 --- a/doc/man/nvme_nvmset_predictable_lat_log.2 +++ b/doc/man/nvme_nvmset_predictable_lat_log.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_nvmset_predictable_lat_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_nvmset_predictable_lat_log" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_nvmset_predictable_lat_log \- +struct nvme_nvmset_predictable_lat_log \- Predictable Latency Mode - Deterministic Threshold Configuration Data .SH SYNOPSIS struct nvme_nvmset_predictable_lat_log { .br diff --git a/doc/man/nvme_open.2 b/doc/man/nvme_open.2 index 5d7e7d0..410b683 100644 --- a/doc/man/nvme_open.2 +++ b/doc/man/nvme_open.2 @@ -1,4 +1,4 @@ -.TH "nvme_open" 9 "nvme_open" "April 2022" "libnvme API manual" LINUX +.TH "nvme_open" 9 "nvme_open" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_open \- Open an nvme controller or namespace device .SH SYNOPSIS diff --git a/doc/man/nvme_passthru_cmd.2 b/doc/man/nvme_passthru_cmd.2 index dbe721a..778b9a3 100644 --- a/doc/man/nvme_passthru_cmd.2 +++ b/doc/man/nvme_passthru_cmd.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_passthru_cmd" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_passthru_cmd" "July 2022" "API Manual" LINUX .SH NAME struct nvme_passthru_cmd \- nvme passthrough command structure .SH SYNOPSIS diff --git a/doc/man/nvme_path_get_ana_state.2 b/doc/man/nvme_path_get_ana_state.2 index aea9250..07e3423 100644 --- a/doc/man/nvme_path_get_ana_state.2 +++ b/doc/man/nvme_path_get_ana_state.2 @@ -1,4 +1,4 @@ -.TH "nvme_path_get_ana_state" 9 "nvme_path_get_ana_state" "April 2022" "libnvme API manual" LINUX +.TH "nvme_path_get_ana_state" 9 "nvme_path_get_ana_state" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_path_get_ana_state \- ANA state of an nvme_path_t object .SH SYNOPSIS diff --git a/doc/man/nvme_path_get_ctrl.2 b/doc/man/nvme_path_get_ctrl.2 index eb5a046..c76b12f 100644 --- a/doc/man/nvme_path_get_ctrl.2 +++ b/doc/man/nvme_path_get_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_path_get_ctrl" 9 "nvme_path_get_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_path_get_ctrl" 9 "nvme_path_get_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_path_get_ctrl \- Parent controller of an nvme_path_t object .SH SYNOPSIS diff --git a/doc/man/nvme_path_get_name.2 b/doc/man/nvme_path_get_name.2 index 5d78c61..fd56240 100644 --- a/doc/man/nvme_path_get_name.2 +++ b/doc/man/nvme_path_get_name.2 @@ -1,4 +1,4 @@ -.TH "nvme_path_get_name" 9 "nvme_path_get_name" "April 2022" "libnvme API manual" LINUX +.TH "nvme_path_get_name" 9 "nvme_path_get_name" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_path_get_name \- sysfs name of an &nvme_path_t object .SH SYNOPSIS diff --git a/doc/man/nvme_path_get_ns.2 b/doc/man/nvme_path_get_ns.2 index 6fb4450..e929690 100644 --- a/doc/man/nvme_path_get_ns.2 +++ b/doc/man/nvme_path_get_ns.2 @@ -1,4 +1,4 @@ -.TH "nvme_path_get_ns" 9 "nvme_path_get_ns" "April 2022" "libnvme API manual" LINUX +.TH "nvme_path_get_ns" 9 "nvme_path_get_ns" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_path_get_ns \- Parent namespace of an nvme_path_t object .SH SYNOPSIS diff --git a/doc/man/nvme_path_get_sysfs_dir.2 b/doc/man/nvme_path_get_sysfs_dir.2 index f14b537..fb2c444 100644 --- a/doc/man/nvme_path_get_sysfs_dir.2 +++ b/doc/man/nvme_path_get_sysfs_dir.2 @@ -1,4 +1,4 @@ -.TH "nvme_path_get_sysfs_dir" 9 "nvme_path_get_sysfs_dir" "April 2022" "libnvme API manual" LINUX +.TH "nvme_path_get_sysfs_dir" 9 "nvme_path_get_sysfs_dir" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_path_get_sysfs_dir \- sysfs directory of an nvme_path_t object .SH SYNOPSIS diff --git a/doc/man/nvme_paths_filter.2 b/doc/man/nvme_paths_filter.2 index d2d2955..e9800e9 100644 --- a/doc/man/nvme_paths_filter.2 +++ b/doc/man/nvme_paths_filter.2 @@ -1,4 +1,4 @@ -.TH "nvme_paths_filter" 9 "nvme_paths_filter" "April 2022" "libnvme API manual" LINUX +.TH "nvme_paths_filter" 9 "nvme_paths_filter" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_paths_filter \- Filter for paths .SH SYNOPSIS diff --git a/doc/man/nvme_persistent_event_entry.2 b/doc/man/nvme_persistent_event_entry.2 index 0e19ab9..b4b2d0b 100644 --- a/doc/man/nvme_persistent_event_entry.2 +++ b/doc/man/nvme_persistent_event_entry.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_persistent_event_entry" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_persistent_event_entry" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_persistent_event_entry \- +struct nvme_persistent_event_entry \- Persistent Event .SH SYNOPSIS struct nvme_persistent_event_entry { .br diff --git a/doc/man/nvme_persistent_event_log.2 b/doc/man/nvme_persistent_event_log.2 index 466b333..1fba166 100644 --- a/doc/man/nvme_persistent_event_log.2 +++ b/doc/man/nvme_persistent_event_log.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_persistent_event_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_persistent_event_log" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_persistent_event_log \- +struct nvme_persistent_event_log \- Persistent Event Log .SH SYNOPSIS struct nvme_persistent_event_log { .br diff --git a/doc/man/nvme_persistent_event_types.2 b/doc/man/nvme_persistent_event_types.2 index 42900f8..36d142c 100644 --- a/doc/man/nvme_persistent_event_types.2 +++ b/doc/man/nvme_persistent_event_types.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_persistent_event_types" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_persistent_event_types" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_persistent_event_types \- +enum nvme_persistent_event_types \- Persistent event log events .SH SYNOPSIS enum nvme_persistent_event_types { .br @@ -57,15 +57,28 @@ enum nvme_persistent_event_types { }; .SH Constants .IP "NVME_PEL_SMART_HEALTH_EVENT" 12 +SMART / Health Log Snapshot Event .IP "NVME_PEL_FW_COMMIT_EVENT" 12 +Firmware Commit Event .IP "NVME_PEL_TIMESTAMP_EVENT" 12 +Timestamp Change Event .IP "NVME_PEL_POWER_ON_RESET_EVENT" 12 +Power-on or Reset Event .IP "NVME_PEL_NSS_HW_ERROR_EVENT" 12 +NVM Subsystem Hardware Error Event .IP "NVME_PEL_CHANGE_NS_EVENT" 12 +Change Namespace Event .IP "NVME_PEL_FORMAT_START_EVENT" 12 +Format NVM Start Event .IP "NVME_PEL_FORMAT_COMPLETION_EVENT" 12 +Format NVM Completion Event .IP "NVME_PEL_SANITIZE_START_EVENT" 12 +Sanitize Start Event .IP "NVME_PEL_SANITIZE_COMPLETION_EVENT" 12 +Sanitize Completion Event .IP "NVME_PEL_SET_FEATURE_EVENT" 12 +Set Feature Event .IP "NVME_PEL_TELEMETRY_CRT" 12 +Telemetry Log Create Event .IP "NVME_PEL_THERMAL_EXCURSION_EVENT" 12 +Thermal Excursion Event diff --git a/doc/man/nvme_pevent_log_action.2 b/doc/man/nvme_pevent_log_action.2 index d0e500b..3bf05d1 100644 --- a/doc/man/nvme_pevent_log_action.2 +++ b/doc/man/nvme_pevent_log_action.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_pevent_log_action" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_pevent_log_action" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_pevent_log_action \- +enum nvme_pevent_log_action \- Persistent Event Log - Action .SH SYNOPSIS enum nvme_pevent_log_action { .br diff --git a/doc/man/nvme_plm_config.2 b/doc/man/nvme_plm_config.2 index 098aec6..ccb7078 100644 --- a/doc/man/nvme_plm_config.2 +++ b/doc/man/nvme_plm_config.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_plm_config" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_plm_config" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_plm_config \- +struct nvme_plm_config \- Predictable Latency Mode - Deterministic Threshold Configuration Data Structure .SH SYNOPSIS struct nvme_plm_config { .br diff --git a/doc/man/nvme_pmr_size.2 b/doc/man/nvme_pmr_size.2 index 07e7906..e9968a5 100644 --- a/doc/man/nvme_pmr_size.2 +++ b/doc/man/nvme_pmr_size.2 @@ -1,4 +1,4 @@ -.TH "nvme_pmr_size" 9 "nvme_pmr_size" "April 2022" "libnvme API manual" LINUX +.TH "nvme_pmr_size" 9 "nvme_pmr_size" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_pmr_size \- Calculate size of persistent memory region elasticity buffer .SH SYNOPSIS @@ -7,5 +7,5 @@ nvme_pmr_size \- Calculate size of persistent memory region elasticity buffer .SH ARGUMENTS .IP "pmrebs" 12 Value from controller register NVME_REG_PMREBS -.SH "DESCRIPTION" -Returns size of controller persistent memory buffer in bytes +.SH "RETURN" +size of controller persistent memory buffer in bytes diff --git a/doc/man/nvme_pmr_throughput.2 b/doc/man/nvme_pmr_throughput.2 index 5a1d88b..f8076b3 100644 --- a/doc/man/nvme_pmr_throughput.2 +++ b/doc/man/nvme_pmr_throughput.2 @@ -1,4 +1,4 @@ -.TH "nvme_pmr_throughput" 9 "nvme_pmr_throughput" "April 2022" "libnvme API manual" LINUX +.TH "nvme_pmr_throughput" 9 "nvme_pmr_throughput" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_pmr_throughput \- Calculate throughput of persistent memory buffer .SH SYNOPSIS @@ -7,5 +7,5 @@ nvme_pmr_throughput \- Calculate throughput of persistent memory buffer .SH ARGUMENTS .IP "pmrswtp" 12 Value from controller register NVME_REG_PMRSWTP -.SH "DESCRIPTION" -Returns throughput of controller persistent memory buffer in bytes/second +.SH "RETURN" +throughput of controller persistent memory buffer in bytes/second diff --git a/doc/man/nvme_power_on_reset_info_list.2 b/doc/man/nvme_power_on_reset_info_list.2 index 2e08e42..5705622 100644 --- a/doc/man/nvme_power_on_reset_info_list.2 +++ b/doc/man/nvme_power_on_reset_info_list.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_power_on_reset_info_list" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_power_on_reset_info_list" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_power_on_reset_info_list \- +struct nvme_power_on_reset_info_list \- Controller Reset Information .SH SYNOPSIS struct nvme_power_on_reset_info_list { .br diff --git a/doc/man/nvme_primary_ctrl_cap.2 b/doc/man/nvme_primary_ctrl_cap.2 index 05aa41d..7dc8975 100644 --- a/doc/man/nvme_primary_ctrl_cap.2 +++ b/doc/man/nvme_primary_ctrl_cap.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_primary_ctrl_cap" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_primary_ctrl_cap" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_primary_ctrl_cap \- +struct nvme_primary_ctrl_cap \- Identify - Controller Capabilities Structure .SH SYNOPSIS struct nvme_primary_ctrl_cap { .br diff --git a/doc/man/nvme_psd_flags.2 b/doc/man/nvme_psd_flags.2 index 655a4db..4254bfa 100644 --- a/doc/man/nvme_psd_flags.2 +++ b/doc/man/nvme_psd_flags.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_psd_flags" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_psd_flags" "July 2022" "API Manual" LINUX .SH NAME enum nvme_psd_flags \- Possible flag values in nvme power state descriptor .SH SYNOPSIS diff --git a/doc/man/nvme_psd_power_scale.2 b/doc/man/nvme_psd_power_scale.2 index 974c60e..286a866 100644 --- a/doc/man/nvme_psd_power_scale.2 +++ b/doc/man/nvme_psd_power_scale.2 @@ -1,4 +1,4 @@ -.TH "nvme_psd_power_scale" 9 "nvme_psd_power_scale" "April 2022" "libnvme API manual" LINUX +.TH "nvme_psd_power_scale" 9 "nvme_psd_power_scale" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_psd_power_scale \- power scale occupies the upper 3 bits .SH SYNOPSIS @@ -7,3 +7,5 @@ nvme_psd_power_scale \- power scale occupies the upper 3 bits .SH ARGUMENTS .IP "ps" 12 power scale value +.SH "RETURN" +power scale value diff --git a/doc/man/nvme_psd_ps.2 b/doc/man/nvme_psd_ps.2 index bd5e403..c05612c 100644 --- a/doc/man/nvme_psd_ps.2 +++ b/doc/man/nvme_psd_ps.2 @@ -1,9 +1,13 @@ -.TH "libnvme" 9 "enum nvme_psd_ps" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_psd_ps" "July 2022" "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 enum nvme_psd_ps { .br +.BI " NVME_PSD_PS_NOT_REPORTED" +, +.br +.br .BI " NVME_PSD_PS_100_MICRO_WATT" , .br @@ -12,6 +16,8 @@ enum nvme_psd_ps { }; .SH Constants +.IP "NVME_PSD_PS_NOT_REPORTED" 12 +Not reported .IP "NVME_PSD_PS_100_MICRO_WATT" 12 0.0001 watt scale .IP "NVME_PSD_PS_10_MILLI_WATT" 12 diff --git a/doc/man/nvme_psd_workload.2 b/doc/man/nvme_psd_workload.2 index 2e2fe26..1628262 100644 --- a/doc/man/nvme_psd_workload.2 +++ b/doc/man/nvme_psd_workload.2 @@ -1,9 +1,13 @@ -.TH "libnvme" 9 "enum nvme_psd_workload" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_psd_workload" "July 2022" "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 enum nvme_psd_workload { .br +.BI " NVME_PSD_WORKLOAD_NP" +, +.br +.br .BI " NVME_PSD_WORKLOAD_1" , .br @@ -12,6 +16,8 @@ enum nvme_psd_workload { }; .SH Constants +.IP "NVME_PSD_WORKLOAD_NP" 12 +The workload is unknown or not provided. .IP "NVME_PSD_WORKLOAD_1" 12 Extended Idle Period with a Burst of Random Write consists of five minutes of idle followed by diff --git a/doc/man/nvme_read.2 b/doc/man/nvme_read.2 index 7e25fe3..04cef23 100644 --- a/doc/man/nvme_read.2 +++ b/doc/man/nvme_read.2 @@ -1,4 +1,4 @@ -.TH "nvme_read" 9 "nvme_read" "April 2022" "libnvme API manual" LINUX +.TH "nvme_read" 9 "nvme_read" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_read \- Submit an nvme user read command .SH SYNOPSIS diff --git a/doc/man/nvme_read_config.2 b/doc/man/nvme_read_config.2 index 3f5867f..361887d 100644 --- a/doc/man/nvme_read_config.2 +++ b/doc/man/nvme_read_config.2 @@ -1,4 +1,4 @@ -.TH "nvme_read_config" 9 "nvme_read_config" "April 2022" "libnvme API manual" LINUX +.TH "nvme_read_config" 9 "nvme_read_config" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_read_config \- Read NVMe JSON configuration file .SH SYNOPSIS diff --git a/doc/man/nvme_refresh_topology.2 b/doc/man/nvme_refresh_topology.2 index 625310c..d8e2e04 100644 --- a/doc/man/nvme_refresh_topology.2 +++ b/doc/man/nvme_refresh_topology.2 @@ -1,4 +1,4 @@ -.TH "nvme_refresh_topology" 9 "nvme_refresh_topology" "April 2022" "libnvme API manual" LINUX +.TH "nvme_refresh_topology" 9 "nvme_refresh_topology" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_refresh_topology \- Refresh nvme_root_t object contents .SH SYNOPSIS diff --git a/doc/man/nvme_register_offsets.2 b/doc/man/nvme_register_offsets.2 index c10bed5..1e8370d 100644 --- a/doc/man/nvme_register_offsets.2 +++ b/doc/man/nvme_register_offsets.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_register_offsets" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_register_offsets" "July 2022" "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 @@ -72,6 +72,10 @@ enum nvme_register_offsets { , .br .br +.BI " NVME_REG_CRTO" +, +.br +.br .BI " NVME_REG_PMRCAP" , .br @@ -134,6 +138,8 @@ Boot Partition Memory Buffer Location Controller Memory Buffer Memory Space Control .IP "NVME_REG_CMBSTS" 12 Controller Memory Buffer Status +.IP "NVME_REG_CRTO" 12 +Controller Ready Timeouts .IP "NVME_REG_PMRCAP" 12 Persistent Memory Capabilities .IP "NVME_REG_PMRCTL" 12 diff --git a/doc/man/nvme_registered_ctrl.2 b/doc/man/nvme_registered_ctrl.2 index b66824e..6cdc059 100644 --- a/doc/man/nvme_registered_ctrl.2 +++ b/doc/man/nvme_registered_ctrl.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_registered_ctrl" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_registered_ctrl" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_registered_ctrl \- +struct nvme_registered_ctrl \- Registered Controller Data Structure .SH SYNOPSIS struct nvme_registered_ctrl { .br diff --git a/doc/man/nvme_registered_ctrl_ext.2 b/doc/man/nvme_registered_ctrl_ext.2 index 04e0da2..63c9174 100644 --- a/doc/man/nvme_registered_ctrl_ext.2 +++ b/doc/man/nvme_registered_ctrl_ext.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_registered_ctrl_ext" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_registered_ctrl_ext" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_registered_ctrl_ext \- +struct nvme_registered_ctrl_ext \- Registered Controller Extended Data Structure .SH SYNOPSIS struct nvme_registered_ctrl_ext { .br diff --git a/doc/man/nvme_rescan_ctrl.2 b/doc/man/nvme_rescan_ctrl.2 index af1c791..9a8a35c 100644 --- a/doc/man/nvme_rescan_ctrl.2 +++ b/doc/man/nvme_rescan_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_rescan_ctrl" 9 "nvme_rescan_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_rescan_ctrl" 9 "nvme_rescan_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_rescan_ctrl \- Rescan an existing controller .SH SYNOPSIS diff --git a/doc/man/nvme_resv_acquire.2 b/doc/man/nvme_resv_acquire.2 index 2a66281..ae09748 100644 --- a/doc/man/nvme_resv_acquire.2 +++ b/doc/man/nvme_resv_acquire.2 @@ -1,4 +1,4 @@ -.TH "nvme_resv_acquire" 9 "nvme_resv_acquire" "April 2022" "libnvme API manual" LINUX +.TH "nvme_resv_acquire" 9 "nvme_resv_acquire" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_resv_acquire \- Send an nvme reservation acquire .SH SYNOPSIS diff --git a/doc/man/nvme_resv_acquire_args.2 b/doc/man/nvme_resv_acquire_args.2 deleted file mode 100644 index bbbda30..0000000 --- a/doc/man/nvme_resv_acquire_args.2 +++ /dev/null @@ -1,52 +0,0 @@ -.TH "libnvme" 9 "struct nvme_resv_acquire_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_resv_acquire_args \- Arguments for the NVMe Reservation Acquire Comand -.SH SYNOPSIS -struct nvme_resv_acquire_args { -.br -.BI " __u64 crkey;" -.br -.BI " __u64 nrkey;" -.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_resv_rtype rtype;" -.br -.BI " enum nvme_resv_racqa racqa;" -.br -.BI " bool iekey;" -.br -.BI " -}; -.br - -.SH Members -.IP "crkey" 12 -The current reservation key associated with the host -.IP "nrkey" 12 -The reservation key to be unregistered from the namespace if -the action is preempt -.IP "result" 12 -The command completion result from CQE dword0 -.IP "args_size" 12 -Size of \fIstruct nvme_resv_acquire_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace identifier -.IP "rtype" 12 -The type of reservation to be create, see \fIenum nvme_resv_rtype\fP -.IP "racqa" 12 -The action that is performed by the command, see \fIenum nvme_resv_racqa\fP -.IP "iekey" 12 -Set to ignore the existing key diff --git a/doc/man/nvme_resv_cptpl.2 b/doc/man/nvme_resv_cptpl.2 index e59177a..403981c 100644 --- a/doc/man/nvme_resv_cptpl.2 +++ b/doc/man/nvme_resv_cptpl.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_resv_cptpl" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_resv_cptpl" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_resv_cptpl \- +enum nvme_resv_cptpl \- Reservation Register - Change Persist Through Power Loss State .SH SYNOPSIS enum nvme_resv_cptpl { .br diff --git a/doc/man/nvme_resv_notification_log.2 b/doc/man/nvme_resv_notification_log.2 index d1e2df8..8fcd985 100644 --- a/doc/man/nvme_resv_notification_log.2 +++ b/doc/man/nvme_resv_notification_log.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_resv_notification_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_resv_notification_log" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_resv_notification_log \- +struct nvme_resv_notification_log \- Reservation Notification Log .SH SYNOPSIS struct nvme_resv_notification_log { .br diff --git a/doc/man/nvme_resv_notify_rnlpt.2 b/doc/man/nvme_resv_notify_rnlpt.2 index 26d54c5..039f01c 100644 --- a/doc/man/nvme_resv_notify_rnlpt.2 +++ b/doc/man/nvme_resv_notify_rnlpt.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_resv_notify_rnlpt" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_resv_notify_rnlpt" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_resv_notify_rnlpt \- +enum nvme_resv_notify_rnlpt \- Reservation Notification Log - Reservation Notification Log Page Type .SH SYNOPSIS enum nvme_resv_notify_rnlpt { .br @@ -21,6 +21,10 @@ enum nvme_resv_notify_rnlpt { }; .SH Constants .IP "NVME_RESV_NOTIFY_RNLPT_EMPTY" 12 +Empty Log Page .IP "NVME_RESV_NOTIFY_RNLPT_REGISTRATION_PREEMPTED" 12 +Registration Preempted .IP "NVME_RESV_NOTIFY_RNLPT_RESERVATION_RELEASED" 12 +Reservation Released .IP "NVME_RESV_NOTIFY_RNLPT_RESERVATION_PREEMPTED" 12 +Reservation Preempted diff --git a/doc/man/nvme_resv_racqa.2 b/doc/man/nvme_resv_racqa.2 index 724eedf..7e8f839 100644 --- a/doc/man/nvme_resv_racqa.2 +++ b/doc/man/nvme_resv_racqa.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_resv_racqa" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_resv_racqa" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_resv_racqa \- +enum nvme_resv_racqa \- Reservation Acquire - Reservation Acquire Action .SH SYNOPSIS enum nvme_resv_racqa { .br diff --git a/doc/man/nvme_resv_register.2 b/doc/man/nvme_resv_register.2 index af51199..ae296bc 100644 --- a/doc/man/nvme_resv_register.2 +++ b/doc/man/nvme_resv_register.2 @@ -1,4 +1,4 @@ -.TH "nvme_resv_register" 9 "nvme_resv_register" "April 2022" "libnvme API manual" LINUX +.TH "nvme_resv_register" 9 "nvme_resv_register" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_resv_register \- Send an nvme reservation register .SH SYNOPSIS diff --git a/doc/man/nvme_resv_register_args.2 b/doc/man/nvme_resv_register_args.2 deleted file mode 100644 index 5654c8d..0000000 --- a/doc/man/nvme_resv_register_args.2 +++ /dev/null @@ -1,52 +0,0 @@ -.TH "libnvme" 9 "struct nvme_resv_register_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_resv_register_args \- Arguments for the NVMe Reservation Register command -.SH SYNOPSIS -struct nvme_resv_register_args { -.br -.BI " __u64 crkey;" -.br -.BI " __u64 nrkey;" -.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_resv_rrega rrega;" -.br -.BI " enum nvme_resv_cptpl cptpl;" -.br -.BI " bool iekey;" -.br -.BI " -}; -.br - -.SH Members -.IP "crkey" 12 -The current reservation key associated with the host -.IP "nrkey" 12 -The new reservation key to be register if action is register or -replace -.IP "result" 12 -The command completion result from CQE dword0 -.IP "args_size" 12 -Size of \fIstruct nvme_resv_register_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace identifier -.IP "rrega" 12 -The registration action, see \fIenum nvme_resv_rrega\fP -.IP "cptpl" 12 -Change persist through power loss, see \fIenum nvme_resv_cptpl\fP -.IP "iekey" 12 -Set to ignore the existing key diff --git a/doc/man/nvme_resv_release.2 b/doc/man/nvme_resv_release.2 index d656ddd..22b8f79 100644 --- a/doc/man/nvme_resv_release.2 +++ b/doc/man/nvme_resv_release.2 @@ -1,4 +1,4 @@ -.TH "nvme_resv_release" 9 "nvme_resv_release" "April 2022" "libnvme API manual" LINUX +.TH "nvme_resv_release" 9 "nvme_resv_release" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_resv_release \- Send an nvme reservation release .SH SYNOPSIS diff --git a/doc/man/nvme_resv_release_args.2 b/doc/man/nvme_resv_release_args.2 deleted file mode 100644 index ad4eeda..0000000 --- a/doc/man/nvme_resv_release_args.2 +++ /dev/null @@ -1,47 +0,0 @@ -.TH "libnvme" 9 "struct nvme_resv_release_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_resv_release_args \- Arguments for the NVMe Reservation Release Command -.SH SYNOPSIS -struct nvme_resv_release_args { -.br -.BI " __u64 crkey;" -.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_resv_rtype rtype;" -.br -.BI " enum nvme_resv_rrela rrela;" -.br -.BI " bool iekey;" -.br -.BI " -}; -.br - -.SH Members -.IP "crkey" 12 -The current reservation key to release -.IP "result" 12 -The command completion result from CQE dword0 -.IP "args_size" 12 -Size of \fIstruct nvme_resv_release_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace identifier -.IP "rtype" 12 -The type of reservation to be create, see \fIenum nvme_resv_rtype\fP -.IP "rrela" 12 -Reservation releast action, see \fIenum nvme_resv_rrela\fP -.IP "iekey" 12 -Set to ignore the existing key diff --git a/doc/man/nvme_resv_report.2 b/doc/man/nvme_resv_report.2 index 0e266d7..b187b78 100644 --- a/doc/man/nvme_resv_report.2 +++ b/doc/man/nvme_resv_report.2 @@ -1,4 +1,4 @@ -.TH "nvme_resv_report" 9 "nvme_resv_report" "April 2022" "libnvme API manual" LINUX +.TH "nvme_resv_report" 9 "nvme_resv_report" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_resv_report \- Send an nvme reservation report .SH SYNOPSIS @@ -9,7 +9,7 @@ nvme_resv_report \- Send an nvme reservation report struct nvme_resv_report_args argument structure .SH "DESCRIPTION" Returns a Reservation Status data structure to memory that describes the -registration and reservation status of a namespace. See the defintion for +registration and reservation status of a namespace. See the definition for the returned structure, \fIstruct nvme_reservation_status\fP, for more details. .SH "RETURN" The nvme command status if a response was received (see diff --git a/doc/man/nvme_resv_report_args.2 b/doc/man/nvme_resv_report_args.2 deleted file mode 100644 index f98fd25..0000000 --- a/doc/man/nvme_resv_report_args.2 +++ /dev/null @@ -1,44 +0,0 @@ -.TH "libnvme" 9 "struct nvme_resv_report_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_resv_report_args \- Arguments for the NVMe Reservation Report command -.SH SYNOPSIS -struct nvme_resv_report_args { -.br -.BI " __u32 *result;" -.br -.BI " struct nvme_resv_status *report;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " __u32 nsid;" -.br -.BI " __u32 len;" -.br -.BI " bool eds;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "report" 12 -The user space destination address to store the reservation -report -.IP "args_size" 12 -Size of \fIstruct nvme_resv_report_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace identifier -.IP "len" 12 -Number of bytes to request transfered with this command -.IP "eds" 12 -Request extended Data Structure diff --git a/doc/man/nvme_resv_rrega.2 b/doc/man/nvme_resv_rrega.2 index dfce261..fc5702a 100644 --- a/doc/man/nvme_resv_rrega.2 +++ b/doc/man/nvme_resv_rrega.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_resv_rrega" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_resv_rrega" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_resv_rrega \- +enum nvme_resv_rrega \- Reservation Register - Reservation Register Action .SH SYNOPSIS enum nvme_resv_rrega { .br diff --git a/doc/man/nvme_resv_rrela.2 b/doc/man/nvme_resv_rrela.2 index b3eb068..c89638c 100644 --- a/doc/man/nvme_resv_rrela.2 +++ b/doc/man/nvme_resv_rrela.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_resv_rrela" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_resv_rrela" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_resv_rrela \- +enum nvme_resv_rrela \- Reservation Release - Reservation Release Action .SH SYNOPSIS enum nvme_resv_rrela { .br diff --git a/doc/man/nvme_resv_rtype.2 b/doc/man/nvme_resv_rtype.2 index bdff164..c75d6fb 100644 --- a/doc/man/nvme_resv_rtype.2 +++ b/doc/man/nvme_resv_rtype.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_resv_rtype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_resv_rtype" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_resv_rtype \- +enum nvme_resv_rtype \- Reservation Type Encoding .SH SYNOPSIS enum nvme_resv_rtype { .br diff --git a/doc/man/nvme_resv_status.2 b/doc/man/nvme_resv_status.2 index cdb117d..7683fbd 100644 --- a/doc/man/nvme_resv_status.2 +++ b/doc/man/nvme_resv_status.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_resv_status" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_resv_status" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_resv_status \- +struct nvme_resv_status \- Reservation Status Data Structure .SH SYNOPSIS struct nvme_resv_status { .br diff --git a/doc/man/nvme_sanitize_compln_event.2 b/doc/man/nvme_sanitize_compln_event.2 index 456e3bc..1ab951e 100644 --- a/doc/man/nvme_sanitize_compln_event.2 +++ b/doc/man/nvme_sanitize_compln_event.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_sanitize_compln_event" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_sanitize_compln_event" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_sanitize_compln_event \- +struct nvme_sanitize_compln_event \- Sanitize Completion Event Data .SH SYNOPSIS struct nvme_sanitize_compln_event { .br diff --git a/doc/man/nvme_sanitize_log_page.2 b/doc/man/nvme_sanitize_log_page.2 index 1a915f5..070635c 100644 --- a/doc/man/nvme_sanitize_log_page.2 +++ b/doc/man/nvme_sanitize_log_page.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_sanitize_log_page" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_sanitize_log_page" "July 2022" "API Manual" LINUX .SH NAME struct nvme_sanitize_log_page \- Sanitize Status (Log Identifier 81h) .SH SYNOPSIS diff --git a/doc/man/nvme_sanitize_nvm.2 b/doc/man/nvme_sanitize_nvm.2 index 89dbcf5..ddbac55 100644 --- a/doc/man/nvme_sanitize_nvm.2 +++ b/doc/man/nvme_sanitize_nvm.2 @@ -1,4 +1,4 @@ -.TH "nvme_sanitize_nvm" 9 "nvme_sanitize_nvm" "April 2022" "libnvme API manual" LINUX +.TH "nvme_sanitize_nvm" 9 "nvme_sanitize_nvm" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_sanitize_nvm \- Start a sanitize operation .SH SYNOPSIS diff --git a/doc/man/nvme_sanitize_nvm_args.2 b/doc/man/nvme_sanitize_nvm_args.2 deleted file mode 100644 index 1a414db..0000000 --- a/doc/man/nvme_sanitize_nvm_args.2 +++ /dev/null @@ -1,51 +0,0 @@ -.TH "libnvme" 9 "struct nvme_sanitize_nvm_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_sanitize_nvm_args \- Arguments for the NVMe Sanitize NVM command -.SH SYNOPSIS -struct nvme_sanitize_nvm_args { -.br -.BI " __u32 *result;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " enum nvme_sanitize_sanact sanact;" -.br -.BI " __u32 ovrpat;" -.br -.BI " bool ause;" -.br -.BI " __u8 owpass;" -.br -.BI " bool oipbp;" -.br -.BI " bool nodas;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "args_size" 12 -Size of \fIstruct nvme_sanitize_nvm_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "sanact" 12 -Sanitize action, see \fIenum nvme_sanitize_sanact\fP -.IP "ovrpat" 12 -Overwrite pattern -.IP "ause" 12 -Set to allow unrestriced sanitize exit -.IP "owpass" 12 -Overwrite pass count -.IP "oipbp" 12 -Set to overwrite invert pattern between passes -.IP "nodas" 12 -Set to not deallocate blocks after sanitizing diff --git a/doc/man/nvme_sanitize_sanact.2 b/doc/man/nvme_sanitize_sanact.2 index 13d1163..baeb5c1 100644 --- a/doc/man/nvme_sanitize_sanact.2 +++ b/doc/man/nvme_sanitize_sanact.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_sanitize_sanact" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_sanitize_sanact" "July 2022" "API Manual" LINUX .SH NAME enum nvme_sanitize_sanact \- Sanitize Action .SH SYNOPSIS diff --git a/doc/man/nvme_sanitize_sstat.2 b/doc/man/nvme_sanitize_sstat.2 index abe4334..db970e4 100644 --- a/doc/man/nvme_sanitize_sstat.2 +++ b/doc/man/nvme_sanitize_sstat.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_sanitize_sstat" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_sanitize_sstat" "July 2022" "API Manual" LINUX .SH NAME enum nvme_sanitize_sstat \- Sanitize Status (SSTAT) .SH SYNOPSIS diff --git a/doc/man/nvme_sanitize_start_event.2 b/doc/man/nvme_sanitize_start_event.2 index 36ea6ea..ba50f4a 100644 --- a/doc/man/nvme_sanitize_start_event.2 +++ b/doc/man/nvme_sanitize_start_event.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_sanitize_start_event" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_sanitize_start_event" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_sanitize_start_event \- +struct nvme_sanitize_start_event \- Sanitize Start Event Data .SH SYNOPSIS struct nvme_sanitize_start_event { .br diff --git a/doc/man/nvme_scan.2 b/doc/man/nvme_scan.2 index 962e786..40c3cf4 100644 --- a/doc/man/nvme_scan.2 +++ b/doc/man/nvme_scan.2 @@ -1,4 +1,4 @@ -.TH "nvme_scan" 9 "nvme_scan" "April 2022" "libnvme API manual" LINUX +.TH "nvme_scan" 9 "nvme_scan" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_scan \- Scan NVMe topology .SH SYNOPSIS diff --git a/doc/man/nvme_scan_ctrl.2 b/doc/man/nvme_scan_ctrl.2 index bef86d0..6da34ea 100644 --- a/doc/man/nvme_scan_ctrl.2 +++ b/doc/man/nvme_scan_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_scan_ctrl" 9 "nvme_scan_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_scan_ctrl" 9 "nvme_scan_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_scan_ctrl \- Scan on a controller .SH SYNOPSIS diff --git a/doc/man/nvme_scan_ctrl_namespace_paths.2 b/doc/man/nvme_scan_ctrl_namespace_paths.2 index db2549e..697c8f2 100644 --- a/doc/man/nvme_scan_ctrl_namespace_paths.2 +++ b/doc/man/nvme_scan_ctrl_namespace_paths.2 @@ -1,4 +1,4 @@ -.TH "nvme_scan_ctrl_namespace_paths" 9 "nvme_scan_ctrl_namespace_paths" "April 2022" "libnvme API manual" LINUX +.TH "nvme_scan_ctrl_namespace_paths" 9 "nvme_scan_ctrl_namespace_paths" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_scan_ctrl_namespace_paths \- Scan for namespace paths in a controller .SH SYNOPSIS diff --git a/doc/man/nvme_scan_ctrl_namespaces.2 b/doc/man/nvme_scan_ctrl_namespaces.2 index aba1eca..ce6e66c 100644 --- a/doc/man/nvme_scan_ctrl_namespaces.2 +++ b/doc/man/nvme_scan_ctrl_namespaces.2 @@ -1,4 +1,4 @@ -.TH "nvme_scan_ctrl_namespaces" 9 "nvme_scan_ctrl_namespaces" "April 2022" "libnvme API manual" LINUX +.TH "nvme_scan_ctrl_namespaces" 9 "nvme_scan_ctrl_namespaces" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_scan_ctrl_namespaces \- Scan for namespaces in a controller .SH SYNOPSIS diff --git a/doc/man/nvme_scan_ctrls.2 b/doc/man/nvme_scan_ctrls.2 index 9c04e6c..b618028 100644 --- a/doc/man/nvme_scan_ctrls.2 +++ b/doc/man/nvme_scan_ctrls.2 @@ -1,4 +1,4 @@ -.TH "nvme_scan_ctrls" 9 "nvme_scan_ctrls" "April 2022" "libnvme API manual" LINUX +.TH "nvme_scan_ctrls" 9 "nvme_scan_ctrls" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_scan_ctrls \- Scan for controllers .SH SYNOPSIS diff --git a/doc/man/nvme_scan_namespace.2 b/doc/man/nvme_scan_namespace.2 index a4c8f83..7321136 100644 --- a/doc/man/nvme_scan_namespace.2 +++ b/doc/man/nvme_scan_namespace.2 @@ -1,4 +1,4 @@ -.TH "nvme_scan_namespace" 9 "nvme_scan_namespace" "April 2022" "libnvme API manual" LINUX +.TH "nvme_scan_namespace" 9 "nvme_scan_namespace" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_scan_namespace \- scan namespace based on sysfs name .SH SYNOPSIS diff --git a/doc/man/nvme_scan_subsystem_namespaces.2 b/doc/man/nvme_scan_subsystem_namespaces.2 index 2915fa1..16222cd 100644 --- a/doc/man/nvme_scan_subsystem_namespaces.2 +++ b/doc/man/nvme_scan_subsystem_namespaces.2 @@ -1,4 +1,4 @@ -.TH "nvme_scan_subsystem_namespaces" 9 "nvme_scan_subsystem_namespaces" "April 2022" "libnvme API manual" LINUX +.TH "nvme_scan_subsystem_namespaces" 9 "nvme_scan_subsystem_namespaces" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_scan_subsystem_namespaces \- Scan for namespaces in a subsystem .SH SYNOPSIS diff --git a/doc/man/nvme_scan_subsystems.2 b/doc/man/nvme_scan_subsystems.2 index 48e0eb8..8749e92 100644 --- a/doc/man/nvme_scan_subsystems.2 +++ b/doc/man/nvme_scan_subsystems.2 @@ -1,4 +1,4 @@ -.TH "nvme_scan_subsystems" 9 "nvme_scan_subsystems" "April 2022" "libnvme API manual" LINUX +.TH "nvme_scan_subsystems" 9 "nvme_scan_subsystems" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_scan_subsystems \- Scan for subsystems .SH SYNOPSIS diff --git a/doc/man/nvme_scan_topology.2 b/doc/man/nvme_scan_topology.2 index 602d8ae..8f9f26f 100644 --- a/doc/man/nvme_scan_topology.2 +++ b/doc/man/nvme_scan_topology.2 @@ -1,4 +1,4 @@ -.TH "nvme_scan_topology" 9 "nvme_scan_topology" "April 2022" "libnvme API manual" LINUX +.TH "nvme_scan_topology" 9 "nvme_scan_topology" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_scan_topology \- Scan NVMe topology and apply filter .SH SYNOPSIS diff --git a/doc/man/nvme_secondary_ctrl.2 b/doc/man/nvme_secondary_ctrl.2 index b6eb2bd..27205b4 100644 --- a/doc/man/nvme_secondary_ctrl.2 +++ b/doc/man/nvme_secondary_ctrl.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_secondary_ctrl" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_secondary_ctrl" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_secondary_ctrl \- +struct nvme_secondary_ctrl \- Secondary Controller Entry .SH SYNOPSIS struct nvme_secondary_ctrl { .br diff --git a/doc/man/nvme_secondary_ctrl_list.2 b/doc/man/nvme_secondary_ctrl_list.2 index 69afc87..6f4d346 100644 --- a/doc/man/nvme_secondary_ctrl_list.2 +++ b/doc/man/nvme_secondary_ctrl_list.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_secondary_ctrl_list" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_secondary_ctrl_list" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_secondary_ctrl_list \- +struct nvme_secondary_ctrl_list \- Secondary Controller List .SH SYNOPSIS struct nvme_secondary_ctrl_list { .br diff --git a/doc/man/nvme_security_receive.2 b/doc/man/nvme_security_receive.2 index 008e6d0..a33e655 100644 --- a/doc/man/nvme_security_receive.2 +++ b/doc/man/nvme_security_receive.2 @@ -1,12 +1,12 @@ -.TH "nvme_security_receive" 9 "nvme_security_receive" "April 2022" "libnvme API manual" LINUX +.TH "nvme_security_receive" 9 "nvme_security_receive" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_security_receive \- +nvme_security_receive \- Security Receive command .SH SYNOPSIS .B "int" nvme_security_receive .BI "(struct nvme_security_receive_args *args " ");" .SH ARGUMENTS .IP "args" 12 -\fIstruct nvme_security_recevice\fP argument structure +\fIstruct nvme_security_receive\fP argument structure .SH "RETURN" The nvme command status if a response was received (see \fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_security_receive_args.2 b/doc/man/nvme_security_receive_args.2 deleted file mode 100644 index 220d3ce..0000000 --- a/doc/man/nvme_security_receive_args.2 +++ /dev/null @@ -1,59 +0,0 @@ -.TH "libnvme" 9 "struct nvme_security_receive_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_security_receive_args \- Arguments for the NVMe Security Receive command -.SH SYNOPSIS -struct nvme_security_receive_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 " __u32 al;" -.br -.BI " __u32 data_len;" -.br -.BI " __u8 nssf;" -.br -.BI " __u8 spsp0;" -.br -.BI " __u8 spsp1;" -.br -.BI " __u8 secp;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "data" 12 -Security data payload to send -.IP "args_size" 12 -Size of \fIstruct nvme_security_receive_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace ID to issue security command on -.IP "al" 12 -Protocol specific allocation length -.IP "data_len" 12 -Data length of the payload in bytes -.IP "nssf" 12 -NVMe Security Specific field -.IP "spsp0" 12 -Security Protocol Specific field -.IP "spsp1" 12 -Security Protocol Specific field -.IP "secp" 12 -Security Protocol diff --git a/doc/man/nvme_security_send.2 b/doc/man/nvme_security_send.2 index cadb73f..85eba7d 100644 --- a/doc/man/nvme_security_send.2 +++ b/doc/man/nvme_security_send.2 @@ -1,6 +1,6 @@ -.TH "nvme_security_send" 9 "nvme_security_send" "April 2022" "libnvme API manual" LINUX +.TH "nvme_security_send" 9 "nvme_security_send" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_security_send \- +nvme_security_send \- Security Send command .SH SYNOPSIS .B "int" nvme_security_send .BI "(struct nvme_security_send_args *args " ");" diff --git a/doc/man/nvme_security_send_args.2 b/doc/man/nvme_security_send_args.2 deleted file mode 100644 index ac9272b..0000000 --- a/doc/man/nvme_security_send_args.2 +++ /dev/null @@ -1,59 +0,0 @@ -.TH "libnvme" 9 "struct nvme_security_send_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_security_send_args \- Arguments for the NVMe Security Send command -.SH SYNOPSIS -struct nvme_security_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 " __u32 tl;" -.br -.BI " __u32 data_len;" -.br -.BI " __u8 nssf;" -.br -.BI " __u8 spsp0;" -.br -.BI " __u8 spsp1;" -.br -.BI " __u8 secp;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "data" 12 -Security data payload to send -.IP "args_size" 12 -Size of \fIstruct nvme_security_send_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace ID to issue security command on -.IP "tl" 12 -Protocol specific transfer length -.IP "data_len" 12 -Data length of the payload in bytes -.IP "nssf" 12 -NVMe Security Specific field -.IP "spsp0" 12 -Security Protocol Specific field -.IP "spsp1" 12 -Security Protocol Specific field -.IP "secp" 12 -Security Protocol diff --git a/doc/man/nvme_self_test_log.2 b/doc/man/nvme_self_test_log.2 index f46cd21..3f471b1 100644 --- a/doc/man/nvme_self_test_log.2 +++ b/doc/man/nvme_self_test_log.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_self_test_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_self_test_log" "July 2022" "API Manual" LINUX .SH NAME struct nvme_self_test_log \- Device Self-test (Log Identifier 06h) .SH SYNOPSIS diff --git a/doc/man/nvme_set_feature_event.2 b/doc/man/nvme_set_feature_event.2 index 00050af..e81f287 100644 --- a/doc/man/nvme_set_feature_event.2 +++ b/doc/man/nvme_set_feature_event.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_set_feature_event" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_set_feature_event" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_set_feature_event \- +struct nvme_set_feature_event \- Set Feature Event Data .SH SYNOPSIS struct nvme_set_feature_event { .br diff --git a/doc/man/nvme_set_features.2 b/doc/man/nvme_set_features.2 index 9a41c06..fa7be81 100644 --- a/doc/man/nvme_set_features.2 +++ b/doc/man/nvme_set_features.2 @@ -1,4 +1,4 @@ -.TH "nvme_set_features" 9 "nvme_set_features" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features" 9 "nvme_set_features" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_set_features \- Set a feature attribute .SH SYNOPSIS diff --git a/doc/man/nvme_set_features_arbitration.2 b/doc/man/nvme_set_features_arbitration.2 index 141d152..3b3040b 100644 --- a/doc/man/nvme_set_features_arbitration.2 +++ b/doc/man/nvme_set_features_arbitration.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_arbitration" 9 "nvme_set_features_arbitration" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_arbitration" 9 "nvme_set_features_arbitration" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_arbitration \- +nvme_set_features_arbitration \- Set arbitration features .SH SYNOPSIS .B "int" nvme_set_features_arbitration .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_args.2 b/doc/man/nvme_set_features_args.2 deleted file mode 100644 index 9c15083..0000000 --- a/doc/man/nvme_set_features_args.2 +++ /dev/null @@ -1,65 +0,0 @@ -.TH "libnvme" 9 "struct nvme_set_features_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_set_features_args \- Arguments for the NVMe Admin Set Feature command -.SH SYNOPSIS -struct nvme_set_features_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 " __u32 cdw11;" -.br -.BI " __u32 cdw12;" -.br -.BI " __u32 cdw13;" -.br -.BI " __u32 cdw15;" -.br -.BI " __u32 data_len;" -.br -.BI " bool save;" -.br -.BI " __u8 uuidx;" -.br -.BI " __u8 fid;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -The command completion result from CQE dword0 -.IP "data" 12 -User address of feature data, if applicable -.IP "args_size" 12 -Size of \fIstruct nvme_set_features_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace ID, if applicable -.IP "cdw11" 12 -Value to set the feature to -.IP "cdw12" 12 -Feature specific command dword12 field -.IP "cdw15" 12 -Feature specific command dword15 field -.IP "data_len" 12 -Length of feature data, if applicable, in bytes -.IP "save" 12 -Save value across power states -.IP "uuidx" 12 -UUID Index for differentiating vendor specific encoding -.IP "fid" 12 -Feature identifier diff --git a/doc/man/nvme_set_features_async_event.2 b/doc/man/nvme_set_features_async_event.2 index e8084db..74a1b57 100644 --- a/doc/man/nvme_set_features_async_event.2 +++ b/doc/man/nvme_set_features_async_event.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_async_event" 9 "nvme_set_features_async_event" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_async_event" 9 "nvme_set_features_async_event" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_async_event \- +nvme_set_features_async_event \- Set asynchronous event feature .SH SYNOPSIS .B "int" nvme_set_features_async_event .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_auto_pst.2 b/doc/man/nvme_set_features_auto_pst.2 index 21597e2..fe49e0e 100644 --- a/doc/man/nvme_set_features_auto_pst.2 +++ b/doc/man/nvme_set_features_auto_pst.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_auto_pst" 9 "nvme_set_features_auto_pst" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_auto_pst" 9 "nvme_set_features_auto_pst" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_auto_pst \- +nvme_set_features_auto_pst \- Set autonomous power state feature .SH SYNOPSIS .B "int" nvme_set_features_auto_pst .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_data.2 b/doc/man/nvme_set_features_data.2 index 43e81bf..b93d06a 100644 --- a/doc/man/nvme_set_features_data.2 +++ b/doc/man/nvme_set_features_data.2 @@ -1,4 +1,4 @@ -.TH "nvme_set_features_data" 9 "nvme_set_features_data" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_data" 9 "nvme_set_features_data" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_set_features_data \- Helper function for @nvme_set_features() .SH SYNOPSIS @@ -28,3 +28,6 @@ Length of feature data, if applicable, in bytes User address of feature data, if applicable .IP "result" 12 The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_endurance_evt_cfg.2 b/doc/man/nvme_set_features_endurance_evt_cfg.2 index c8e796a..f02853b 100644 --- a/doc/man/nvme_set_features_endurance_evt_cfg.2 +++ b/doc/man/nvme_set_features_endurance_evt_cfg.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_endurance_evt_cfg" 9 "nvme_set_features_endurance_evt_cfg" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_endurance_evt_cfg" 9 "nvme_set_features_endurance_evt_cfg" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_endurance_evt_cfg \- +nvme_set_features_endurance_evt_cfg \- Set endurance event config feature .SH SYNOPSIS .B "int" nvme_set_features_endurance_evt_cfg .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_err_recovery.2 b/doc/man/nvme_set_features_err_recovery.2 index 69de02e..90f3e60 100644 --- a/doc/man/nvme_set_features_err_recovery.2 +++ b/doc/man/nvme_set_features_err_recovery.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_err_recovery" 9 "nvme_set_features_err_recovery" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_err_recovery" 9 "nvme_set_features_err_recovery" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_err_recovery \- +nvme_set_features_err_recovery \- Set error recovery feature .SH SYNOPSIS .B "int" nvme_set_features_err_recovery .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_hctm.2 b/doc/man/nvme_set_features_hctm.2 index 6b47711..5c7e921 100644 --- a/doc/man/nvme_set_features_hctm.2 +++ b/doc/man/nvme_set_features_hctm.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_hctm" 9 "nvme_set_features_hctm" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_hctm" 9 "nvme_set_features_hctm" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_hctm \- +nvme_set_features_hctm \- Set thermal management feature .SH SYNOPSIS .B "int" nvme_set_features_hctm .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_host_behavior.2 b/doc/man/nvme_set_features_host_behavior.2 index 271dbb2..6ce30b1 100644 --- a/doc/man/nvme_set_features_host_behavior.2 +++ b/doc/man/nvme_set_features_host_behavior.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_host_behavior" 9 "nvme_set_features_host_behavior" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_host_behavior" 9 "nvme_set_features_host_behavior" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_host_behavior \- +nvme_set_features_host_behavior \- Set host behavior feature .SH SYNOPSIS .B "int" nvme_set_features_host_behavior .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_host_id.2 b/doc/man/nvme_set_features_host_id.2 index 09de5d5..26da6c4 100644 --- a/doc/man/nvme_set_features_host_id.2 +++ b/doc/man/nvme_set_features_host_id.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_host_id" 9 "nvme_set_features_host_id" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_host_id" 9 "nvme_set_features_host_id" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_host_id \- +nvme_set_features_host_id \- Set enable extended host identifers feature .SH SYNOPSIS .B "int" nvme_set_features_host_id .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_irq_coalesce.2 b/doc/man/nvme_set_features_irq_coalesce.2 index 58d2e3f..ab16b73 100644 --- a/doc/man/nvme_set_features_irq_coalesce.2 +++ b/doc/man/nvme_set_features_irq_coalesce.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_irq_coalesce" 9 "nvme_set_features_irq_coalesce" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_irq_coalesce" 9 "nvme_set_features_irq_coalesce" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_irq_coalesce \- +nvme_set_features_irq_coalesce \- Set IRQ coalesce feature .SH SYNOPSIS .B "int" nvme_set_features_irq_coalesce .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_irq_config.2 b/doc/man/nvme_set_features_irq_config.2 index ffce575..0b28efa 100644 --- a/doc/man/nvme_set_features_irq_config.2 +++ b/doc/man/nvme_set_features_irq_config.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_irq_config" 9 "nvme_set_features_irq_config" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_irq_config" 9 "nvme_set_features_irq_config" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_irq_config \- +nvme_set_features_irq_config \- Set IRQ config feature .SH SYNOPSIS .B "int" nvme_set_features_irq_config .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_lba_range.2 b/doc/man/nvme_set_features_lba_range.2 index 94ca62d..85636da 100644 --- a/doc/man/nvme_set_features_lba_range.2 +++ b/doc/man/nvme_set_features_lba_range.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_lba_range" 9 "nvme_set_features_lba_range" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_lba_range" 9 "nvme_set_features_lba_range" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_lba_range \- +nvme_set_features_lba_range \- Set LBA range feature .SH SYNOPSIS .B "int" nvme_set_features_lba_range .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_lba_sts_interval.2 b/doc/man/nvme_set_features_lba_sts_interval.2 index 1507a76..61fe46f 100644 --- a/doc/man/nvme_set_features_lba_sts_interval.2 +++ b/doc/man/nvme_set_features_lba_sts_interval.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_lba_sts_interval" 9 "nvme_set_features_lba_sts_interval" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_lba_sts_interval" 9 "nvme_set_features_lba_sts_interval" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_lba_sts_interval \- +nvme_set_features_lba_sts_interval \- Set LBA status information feature .SH SYNOPSIS .B "int" nvme_set_features_lba_sts_interval .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_nopsc.2 b/doc/man/nvme_set_features_nopsc.2 index c3ed464..07f7062 100644 --- a/doc/man/nvme_set_features_nopsc.2 +++ b/doc/man/nvme_set_features_nopsc.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_nopsc" 9 "nvme_set_features_nopsc" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_nopsc" 9 "nvme_set_features_nopsc" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_nopsc \- +nvme_set_features_nopsc \- Set non-operational power state feature .SH SYNOPSIS .B "int" nvme_set_features_nopsc .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_plm_config.2 b/doc/man/nvme_set_features_plm_config.2 index 3443b6f..bcb2a2d 100644 --- a/doc/man/nvme_set_features_plm_config.2 +++ b/doc/man/nvme_set_features_plm_config.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_plm_config" 9 "nvme_set_features_plm_config" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_plm_config" 9 "nvme_set_features_plm_config" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_plm_config \- +nvme_set_features_plm_config \- Set predictable latency feature .SH SYNOPSIS .B "int" nvme_set_features_plm_config .BI "(int fd " "," @@ -8,7 +8,7 @@ nvme_set_features_plm_config \- .BI "__u16 nvmsetid " "," .BI "bool save " "," .BI "struct nvme_plm_config *data " "," -.BI "__u32*result " ");" +.BI "__u32 *result " ");" .SH ARGUMENTS .IP "fd" 12 File descriptor of nvme device diff --git a/doc/man/nvme_set_features_plm_window.2 b/doc/man/nvme_set_features_plm_window.2 index 66cf86d..67d00fe 100644 --- a/doc/man/nvme_set_features_plm_window.2 +++ b/doc/man/nvme_set_features_plm_window.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_plm_window" 9 "nvme_set_features_plm_window" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_plm_window" 9 "nvme_set_features_plm_window" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_plm_window \- +nvme_set_features_plm_window \- Set window select feature .SH SYNOPSIS .B "int" nvme_set_features_plm_window .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_power_mgmt.2 b/doc/man/nvme_set_features_power_mgmt.2 index 1cce50e..9937d6e 100644 --- a/doc/man/nvme_set_features_power_mgmt.2 +++ b/doc/man/nvme_set_features_power_mgmt.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_power_mgmt" 9 "nvme_set_features_power_mgmt" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_power_mgmt" 9 "nvme_set_features_power_mgmt" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_power_mgmt \- +nvme_set_features_power_mgmt \- Set power management feature .SH SYNOPSIS .B "int" nvme_set_features_power_mgmt .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_resv_mask.2 b/doc/man/nvme_set_features_resv_mask.2 index 5804011..3772603 100644 --- a/doc/man/nvme_set_features_resv_mask.2 +++ b/doc/man/nvme_set_features_resv_mask.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_resv_mask" 9 "nvme_set_features_resv_mask" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_resv_mask" 9 "nvme_set_features_resv_mask" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_resv_mask \- +nvme_set_features_resv_mask \- Set reservation notification mask feature .SH SYNOPSIS .B "int" nvme_set_features_resv_mask .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_resv_persist.2 b/doc/man/nvme_set_features_resv_persist.2 index e487d6f..fc6e934 100644 --- a/doc/man/nvme_set_features_resv_persist.2 +++ b/doc/man/nvme_set_features_resv_persist.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_resv_persist" 9 "nvme_set_features_resv_persist" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_resv_persist" 9 "nvme_set_features_resv_persist" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_resv_persist \- +nvme_set_features_resv_persist \- Set persist through power loss feature .SH SYNOPSIS .B "int" nvme_set_features_resv_persist .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_rrl.2 b/doc/man/nvme_set_features_rrl.2 index d2b264c..7201d10 100644 --- a/doc/man/nvme_set_features_rrl.2 +++ b/doc/man/nvme_set_features_rrl.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_rrl" 9 "nvme_set_features_rrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_rrl" 9 "nvme_set_features_rrl" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_rrl \- +nvme_set_features_rrl \- Set read recovery level feature .SH SYNOPSIS .B "int" nvme_set_features_rrl .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_sanitize.2 b/doc/man/nvme_set_features_sanitize.2 index c1fe032..ec70e22 100644 --- a/doc/man/nvme_set_features_sanitize.2 +++ b/doc/man/nvme_set_features_sanitize.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_sanitize" 9 "nvme_set_features_sanitize" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_sanitize" 9 "nvme_set_features_sanitize" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_sanitize \- +nvme_set_features_sanitize \- Set sanitize feature .SH SYNOPSIS .B "int" nvme_set_features_sanitize .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_simple.2 b/doc/man/nvme_set_features_simple.2 index 3a1d8de..736f067 100644 --- a/doc/man/nvme_set_features_simple.2 +++ b/doc/man/nvme_set_features_simple.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_simple" 9 "nvme_set_features_simple" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_simple" 9 "nvme_set_features_simple" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_simple \- Helper functionn for @nvme_set_features() +nvme_set_features_simple \- Helper function for @nvme_set_features() .SH SYNOPSIS .B "int" nvme_set_features_simple .BI "(int fd " "," @@ -22,3 +22,6 @@ Value to set the feature to Save value across power states .IP "result" 12 The command completion result from CQE dword0 +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_sw_progress.2 b/doc/man/nvme_set_features_sw_progress.2 index eb48ccd..95e3f16 100644 --- a/doc/man/nvme_set_features_sw_progress.2 +++ b/doc/man/nvme_set_features_sw_progress.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_sw_progress" 9 "nvme_set_features_sw_progress" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_sw_progress" 9 "nvme_set_features_sw_progress" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_sw_progress \- +nvme_set_features_sw_progress \- Set pre-boot software load count feature .SH SYNOPSIS .B "int" nvme_set_features_sw_progress .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_temp_thresh.2 b/doc/man/nvme_set_features_temp_thresh.2 index ae653c1..d7b4e88 100644 --- a/doc/man/nvme_set_features_temp_thresh.2 +++ b/doc/man/nvme_set_features_temp_thresh.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_temp_thresh" 9 "nvme_set_features_temp_thresh" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_temp_thresh" 9 "nvme_set_features_temp_thresh" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_temp_thresh \- +nvme_set_features_temp_thresh \- Set temperature threshold feature .SH SYNOPSIS .B "int" nvme_set_features_temp_thresh .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_timestamp.2 b/doc/man/nvme_set_features_timestamp.2 index f286a0d..9c9c511 100644 --- a/doc/man/nvme_set_features_timestamp.2 +++ b/doc/man/nvme_set_features_timestamp.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_timestamp" 9 "nvme_set_features_timestamp" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_timestamp" 9 "nvme_set_features_timestamp" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_timestamp \- +nvme_set_features_timestamp \- Set timestamp feature .SH SYNOPSIS .B "int" nvme_set_features_timestamp .BI "(int fd " "," @@ -12,7 +12,7 @@ File descriptor of nvme device .IP "save" 12 Save value across power states .IP "timestamp" 12 -The current timestamp value to assign to this this feature +The current timestamp value to assign to this feature .SH "RETURN" The nvme command status if a response was received (see \fIenum nvme_status_field\fP) or -1 with errno set otherwise. diff --git a/doc/man/nvme_set_features_volatile_wc.2 b/doc/man/nvme_set_features_volatile_wc.2 index 4ec60c8..15ff174 100644 --- a/doc/man/nvme_set_features_volatile_wc.2 +++ b/doc/man/nvme_set_features_volatile_wc.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_volatile_wc" 9 "nvme_set_features_volatile_wc" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_volatile_wc" 9 "nvme_set_features_volatile_wc" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_volatile_wc \- +nvme_set_features_volatile_wc \- Set volatile write cache feature .SH SYNOPSIS .B "int" nvme_set_features_volatile_wc .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_write_atomic.2 b/doc/man/nvme_set_features_write_atomic.2 index 5037a0b..92823ef 100644 --- a/doc/man/nvme_set_features_write_atomic.2 +++ b/doc/man/nvme_set_features_write_atomic.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_write_atomic" 9 "nvme_set_features_write_atomic" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_write_atomic" 9 "nvme_set_features_write_atomic" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_write_atomic \- +nvme_set_features_write_atomic \- Set write atomic feature .SH SYNOPSIS .B "int" nvme_set_features_write_atomic .BI "(int fd " "," diff --git a/doc/man/nvme_set_features_write_protect.2 b/doc/man/nvme_set_features_write_protect.2 index e87dfe1..1808846 100644 --- a/doc/man/nvme_set_features_write_protect.2 +++ b/doc/man/nvme_set_features_write_protect.2 @@ -1,6 +1,6 @@ -.TH "nvme_set_features_write_protect" 9 "nvme_set_features_write_protect" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_features_write_protect" 9 "nvme_set_features_write_protect" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_set_features_write_protect \- +nvme_set_features_write_protect \- Set write protect feature .SH SYNOPSIS .B "int" nvme_set_features_write_protect .BI "(int fd " "," diff --git a/doc/man/nvme_set_property.2 b/doc/man/nvme_set_property.2 index 6d484a1..10056d5 100644 --- a/doc/man/nvme_set_property.2 +++ b/doc/man/nvme_set_property.2 @@ -1,4 +1,4 @@ -.TH "nvme_set_property" 9 "nvme_set_property" "April 2022" "libnvme API manual" LINUX +.TH "nvme_set_property" 9 "nvme_set_property" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_set_property \- Set controller property .SH SYNOPSIS diff --git a/doc/man/nvme_set_property_args.2 b/doc/man/nvme_set_property_args.2 deleted file mode 100644 index 3d40857..0000000 --- a/doc/man/nvme_set_property_args.2 +++ /dev/null @@ -1,35 +0,0 @@ -.TH "libnvme" 9 "struct nvme_set_property_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_set_property_args \- Arguments for NVMe Set Property command -.SH SYNOPSIS -struct nvme_set_property_args { -.br -.BI " __u64 value;" -.br -.BI " __u32 *result;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " int offset;" -.br -.BI " -}; -.br - -.SH Members -.IP "value" 12 -The value to set the property -.IP "result" 12 -The command completion result from CQE dword0 -.IP "args_size" 12 -Size of \fIstruct nvme_set_property_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "offset" 12 -Property offset from the base to set diff --git a/doc/man/nvme_smart_crit.2 b/doc/man/nvme_smart_crit.2 index 9a23b81..a7a5dd2 100644 --- a/doc/man/nvme_smart_crit.2 +++ b/doc/man/nvme_smart_crit.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_smart_crit" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_smart_crit" "July 2022" "API Manual" LINUX .SH NAME enum nvme_smart_crit \- Critical Warning .SH SYNOPSIS diff --git a/doc/man/nvme_smart_egcw.2 b/doc/man/nvme_smart_egcw.2 index 9bb08a9..50574e1 100644 --- a/doc/man/nvme_smart_egcw.2 +++ b/doc/man/nvme_smart_egcw.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_smart_egcw" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_smart_egcw" "July 2022" "API Manual" LINUX .SH NAME enum nvme_smart_egcw \- Endurance Group Critical Warning Summary .SH SYNOPSIS diff --git a/doc/man/nvme_smart_log.2 b/doc/man/nvme_smart_log.2 index beac84c..642a95b 100644 --- a/doc/man/nvme_smart_log.2 +++ b/doc/man/nvme_smart_log.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_smart_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_smart_log" "July 2022" "API Manual" LINUX .SH NAME struct nvme_smart_log \- SMART / Health Information Log (Log Identifier 02h) .SH SYNOPSIS diff --git a/doc/man/nvme_st_code.2 b/doc/man/nvme_st_code.2 index 83b3aaa..5828169 100644 --- a/doc/man/nvme_st_code.2 +++ b/doc/man/nvme_st_code.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_st_code" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_st_code" "July 2022" "API Manual" LINUX .SH NAME enum nvme_st_code \- Self-test Code value .SH SYNOPSIS diff --git a/doc/man/nvme_st_curr_op.2 b/doc/man/nvme_st_curr_op.2 index 1148499..e7c4efe 100644 --- a/doc/man/nvme_st_curr_op.2 +++ b/doc/man/nvme_st_curr_op.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_st_curr_op" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_st_curr_op" "July 2022" "API Manual" LINUX .SH NAME enum nvme_st_curr_op \- Current Device Self-Test Operation .SH SYNOPSIS diff --git a/doc/man/nvme_st_result.2 b/doc/man/nvme_st_result.2 index e8b2b34..a8062ff 100644 --- a/doc/man/nvme_st_result.2 +++ b/doc/man/nvme_st_result.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_st_result" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_st_result" "July 2022" "API Manual" LINUX .SH NAME struct nvme_st_result \- Self-test Result .SH SYNOPSIS diff --git a/doc/man/nvme_st_valid_diag_info.2 b/doc/man/nvme_st_valid_diag_info.2 index 09d123a..40eaaf3 100644 --- a/doc/man/nvme_st_valid_diag_info.2 +++ b/doc/man/nvme_st_valid_diag_info.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_st_valid_diag_info" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_st_valid_diag_info" "July 2022" "API Manual" LINUX .SH NAME enum nvme_st_valid_diag_info \- Valid Diagnostic Information .SH SYNOPSIS diff --git a/doc/man/nvme_status_code.2 b/doc/man/nvme_status_code.2 index 2087a4f..bf04cb5 100644 --- a/doc/man/nvme_status_code.2 +++ b/doc/man/nvme_status_code.2 @@ -1,4 +1,4 @@ -.TH "nvme_status_code" 9 "nvme_status_code" "April 2022" "libnvme API manual" LINUX +.TH "nvme_status_code" 9 "nvme_status_code" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_status_code \- Returns the NVMe Status Code .SH SYNOPSIS @@ -7,5 +7,6 @@ nvme_status_code \- Returns the NVMe Status Code .SH ARGUMENTS .IP "status_field" 12 The NVMe Completion Queue Entry's Status Field -.SH "DESCRIPTION" See \fIenum nvme_status_field\fP +.SH "RETURN" +status code diff --git a/doc/man/nvme_status_code_type.2 b/doc/man/nvme_status_code_type.2 index 39fb999..7a1684d 100644 --- a/doc/man/nvme_status_code_type.2 +++ b/doc/man/nvme_status_code_type.2 @@ -1,4 +1,4 @@ -.TH "nvme_status_code_type" 9 "nvme_status_code_type" "April 2022" "libnvme API manual" LINUX +.TH "nvme_status_code_type" 9 "nvme_status_code_type" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_status_code_type \- Returns the NVMe Status Code Type .SH SYNOPSIS @@ -7,5 +7,6 @@ nvme_status_code_type \- Returns the NVMe Status Code Type .SH ARGUMENTS .IP "status_field" 12 The NVMe Completion Queue Entry's Status Field -.SH "DESCRIPTION" See \fIenum nvme_status_field\fP +.SH "RETURN" +status code type diff --git a/doc/man/nvme_status_field.2 b/doc/man/nvme_status_field.2 index d39a561..b5e43ef 100644 --- a/doc/man/nvme_status_field.2 +++ b/doc/man/nvme_status_field.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_status_field" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_status_field" "July 2022" "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 @@ -585,11 +585,13 @@ Vendor specific errors .IP "NVME_SCT_MASK" 12 Mask to get the value of the Status Code Type .IP "NVME_SCT_SHIFT" 12 --- undescribed -- +Shift value to get the value of the Status +Code Type .IP "NVME_SC_MASK" 12 Mask to get the value of the status code. .IP "NVME_SC_SHIFT" 12 --- undescribed -- +Shift value to get the value of the status +code. .IP "NVME_SC_SUCCESS" 12 Successful Completion: The command completed without error. @@ -996,7 +998,10 @@ transient condition. Fabric Zoning is not enabled on the CDC .IP "NVME_SC_ZONEGRP_ORIGINATOR_INVLD" 12 --- undescribed -- +The NQN contained in the ZoneGroup +Originator field does not match the +Host NQN used by the DDC to connect +to the CDC. .IP "NVME_SC_BAD_ATTRIBUTES" 12 Conflicting Dataset Management Attributes .IP "NVME_SC_INVALID_PI" 12 diff --git a/doc/man/nvme_status_result.2 b/doc/man/nvme_status_result.2 index e1e51ad..3b01c3f 100644 --- a/doc/man/nvme_status_result.2 +++ b/doc/man/nvme_status_result.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_status_result" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_status_result" "July 2022" "API Manual" LINUX .SH NAME enum nvme_status_result \- Result of the device self-test operation .SH SYNOPSIS diff --git a/doc/man/nvme_status_to_errno.2 b/doc/man/nvme_status_to_errno.2 index d5174a7..438c7fd 100644 --- a/doc/man/nvme_status_to_errno.2 +++ b/doc/man/nvme_status_to_errno.2 @@ -1,4 +1,4 @@ -.TH "nvme_status_to_errno" 9 "nvme_status_to_errno" "April 2022" "libnvme API manual" LINUX +.TH "nvme_status_to_errno" 9 "nvme_status_to_errno" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_status_to_errno \- Converts nvme return status to errno .SH SYNOPSIS @@ -7,7 +7,7 @@ nvme_status_to_errno \- Converts nvme return status to errno .BI "bool fabrics " ");" .SH ARGUMENTS .IP "status" 12 -Return status from an nvme passthrough commmand +Return status from an nvme passthrough command .IP "fabrics" 12 Set to true if \fIstatus\fP is to a fabrics target. .SH "RETURN" diff --git a/doc/man/nvme_status_to_string.2 b/doc/man/nvme_status_to_string.2 index c91938d..a86e3d9 100644 --- a/doc/man/nvme_status_to_string.2 +++ b/doc/man/nvme_status_to_string.2 @@ -1,4 +1,4 @@ -.TH "nvme_status_to_string" 9 "nvme_status_to_string" "April 2022" "libnvme API manual" LINUX +.TH "nvme_status_to_string" 9 "nvme_status_to_string" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_status_to_string \- Returns string describing nvme return status. .SH SYNOPSIS @@ -7,7 +7,7 @@ nvme_status_to_string \- Returns string describing nvme return status. .BI "bool fabrics " ");" .SH ARGUMENTS .IP "status" 12 -Return status from an nvme passthrough commmand +Return status from an nvme passthrough command .IP "fabrics" 12 Set to true if \fIstatus\fP is to a fabrics target. .SH "RETURN" diff --git a/doc/man/nvme_streams_directive_params.2 b/doc/man/nvme_streams_directive_params.2 index c2dd59a..1f9197d 100644 --- a/doc/man/nvme_streams_directive_params.2 +++ b/doc/man/nvme_streams_directive_params.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_streams_directive_params" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_streams_directive_params" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_streams_directive_params \- +struct nvme_streams_directive_params \- Streams Directive - Return Parameters Data Structure .SH SYNOPSIS struct nvme_streams_directive_params { .br diff --git a/doc/man/nvme_streams_directive_status.2 b/doc/man/nvme_streams_directive_status.2 index 5b0a192..a86ba6c 100644 --- a/doc/man/nvme_streams_directive_status.2 +++ b/doc/man/nvme_streams_directive_status.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_streams_directive_status" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_streams_directive_status" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_streams_directive_status \- +struct nvme_streams_directive_status \- Streams Directive - Get Status Data Structure .SH SYNOPSIS struct nvme_streams_directive_status { .br diff --git a/doc/man/nvme_submit_admin_passthru.2 b/doc/man/nvme_submit_admin_passthru.2 index 823bbff..c19296e 100644 --- a/doc/man/nvme_submit_admin_passthru.2 +++ b/doc/man/nvme_submit_admin_passthru.2 @@ -1,4 +1,4 @@ -.TH "nvme_submit_admin_passthru" 9 "nvme_submit_admin_passthru" "April 2022" "libnvme API manual" LINUX +.TH "nvme_submit_admin_passthru" 9 "nvme_submit_admin_passthru" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_submit_admin_passthru \- Submit an nvme passthrough admin command .SH SYNOPSIS diff --git a/doc/man/nvme_submit_io_passthru.2 b/doc/man/nvme_submit_io_passthru.2 index 8319a47..e939991 100644 --- a/doc/man/nvme_submit_io_passthru.2 +++ b/doc/man/nvme_submit_io_passthru.2 @@ -1,4 +1,4 @@ -.TH "nvme_submit_io_passthru" 9 "nvme_submit_io_passthru" "April 2022" "libnvme API manual" LINUX +.TH "nvme_submit_io_passthru" 9 "nvme_submit_io_passthru" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_submit_io_passthru \- Submit an nvme passthrough command .SH SYNOPSIS diff --git a/doc/man/nvme_subsys_filter.2 b/doc/man/nvme_subsys_filter.2 index c53a5e5..97abdfa 100644 --- a/doc/man/nvme_subsys_filter.2 +++ b/doc/man/nvme_subsys_filter.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsys_filter" 9 "nvme_subsys_filter" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsys_filter" 9 "nvme_subsys_filter" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsys_filter \- Filter for subsystems .SH SYNOPSIS diff --git a/doc/man/nvme_subsys_type.2 b/doc/man/nvme_subsys_type.2 index 8abd195..e753988 100644 --- a/doc/man/nvme_subsys_type.2 +++ b/doc/man/nvme_subsys_type.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_subsys_type" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_subsys_type" "July 2022" "API Manual" LINUX .SH NAME enum nvme_subsys_type \- Type of the NVM subsystem. .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_first_ctrl.2 b/doc/man/nvme_subsystem_first_ctrl.2 index 0080c21..126b4ce 100644 --- a/doc/man/nvme_subsystem_first_ctrl.2 +++ b/doc/man/nvme_subsystem_first_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_first_ctrl" 9 "nvme_subsystem_first_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_first_ctrl" 9 "nvme_subsystem_first_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_first_ctrl \- First ctrl iterator .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_first_ns.2 b/doc/man/nvme_subsystem_first_ns.2 index 77e6f06..20d02e1 100644 --- a/doc/man/nvme_subsystem_first_ns.2 +++ b/doc/man/nvme_subsystem_first_ns.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_first_ns" 9 "nvme_subsystem_first_ns" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_first_ns" 9 "nvme_subsystem_first_ns" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_first_ns \- Start namespace iterator .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_for_each_ctrl.2 b/doc/man/nvme_subsystem_for_each_ctrl.2 index b2f90f1..8c053b4 100644 --- a/doc/man/nvme_subsystem_for_each_ctrl.2 +++ b/doc/man/nvme_subsystem_for_each_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_for_each_ctrl" 9 "nvme_subsystem_for_each_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_for_each_ctrl" 9 "nvme_subsystem_for_each_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_for_each_ctrl \- Traverse controllers .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_for_each_ctrl_safe.2 b/doc/man/nvme_subsystem_for_each_ctrl_safe.2 index 5c61ad8..5e158b9 100644 --- a/doc/man/nvme_subsystem_for_each_ctrl_safe.2 +++ b/doc/man/nvme_subsystem_for_each_ctrl_safe.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_for_each_ctrl_safe" 9 "nvme_subsystem_for_each_ctrl_safe" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_for_each_ctrl_safe" 9 "nvme_subsystem_for_each_ctrl_safe" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_for_each_ctrl_safe \- Traverse controllers .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_for_each_ns.2 b/doc/man/nvme_subsystem_for_each_ns.2 index ed20603..65af75b 100644 --- a/doc/man/nvme_subsystem_for_each_ns.2 +++ b/doc/man/nvme_subsystem_for_each_ns.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_for_each_ns" 9 "nvme_subsystem_for_each_ns" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_for_each_ns" 9 "nvme_subsystem_for_each_ns" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_for_each_ns \- Traverse namespaces .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_for_each_ns_safe.2 b/doc/man/nvme_subsystem_for_each_ns_safe.2 index 7b565bf..055963a 100644 --- a/doc/man/nvme_subsystem_for_each_ns_safe.2 +++ b/doc/man/nvme_subsystem_for_each_ns_safe.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_for_each_ns_safe" 9 "nvme_subsystem_for_each_ns_safe" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_for_each_ns_safe" 9 "nvme_subsystem_for_each_ns_safe" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_for_each_ns_safe \- Traverse namespaces .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_get_host.2 b/doc/man/nvme_subsystem_get_host.2 index cdabc3f..4f147ff 100644 --- a/doc/man/nvme_subsystem_get_host.2 +++ b/doc/man/nvme_subsystem_get_host.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_get_host" 9 "nvme_subsystem_get_host" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_get_host" 9 "nvme_subsystem_get_host" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_get_host \- Returns nvme_host_t object .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_get_name.2 b/doc/man/nvme_subsystem_get_name.2 index a5c7335..2951bff 100644 --- a/doc/man/nvme_subsystem_get_name.2 +++ b/doc/man/nvme_subsystem_get_name.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_get_name" 9 "nvme_subsystem_get_name" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_get_name" 9 "nvme_subsystem_get_name" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_get_name \- sysfs name of an nvme_subsystem_t object .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_get_nqn.2 b/doc/man/nvme_subsystem_get_nqn.2 index 45aea5e..6f70784 100644 --- a/doc/man/nvme_subsystem_get_nqn.2 +++ b/doc/man/nvme_subsystem_get_nqn.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_get_nqn" 9 "nvme_subsystem_get_nqn" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_get_nqn" 9 "nvme_subsystem_get_nqn" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_get_nqn \- Retrieve NQN from subsystem .SH SYNOPSIS @@ -8,4 +8,4 @@ nvme_subsystem_get_nqn \- Retrieve NQN from subsystem .IP "s" 12 nvme_subsystem_t object .SH "RETURN" -NQN of systemstem +NQN of subsystem diff --git a/doc/man/nvme_subsystem_get_sysfs_dir.2 b/doc/man/nvme_subsystem_get_sysfs_dir.2 index d07e445..be05669 100644 --- a/doc/man/nvme_subsystem_get_sysfs_dir.2 +++ b/doc/man/nvme_subsystem_get_sysfs_dir.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_get_sysfs_dir" 9 "nvme_subsystem_get_sysfs_dir" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_get_sysfs_dir" 9 "nvme_subsystem_get_sysfs_dir" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_get_sysfs_dir \- sysfs directory of an nvme_subsystem_t object .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_get_type.2 b/doc/man/nvme_subsystem_get_type.2 index 55c1b99..3cb01bf 100644 --- a/doc/man/nvme_subsystem_get_type.2 +++ b/doc/man/nvme_subsystem_get_type.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_get_type" 9 "nvme_subsystem_get_type" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_get_type" 9 "nvme_subsystem_get_type" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_get_type \- Returns the type of a subsystem .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_lookup_namespace.2 b/doc/man/nvme_subsystem_lookup_namespace.2 index 201c3fd..2c770aa 100644 --- a/doc/man/nvme_subsystem_lookup_namespace.2 +++ b/doc/man/nvme_subsystem_lookup_namespace.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_lookup_namespace" 9 "nvme_subsystem_lookup_namespace" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_lookup_namespace" 9 "nvme_subsystem_lookup_namespace" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_lookup_namespace \- lookup namespace by NSID .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_next_ctrl.2 b/doc/man/nvme_subsystem_next_ctrl.2 index 971ab8a..8c742a0 100644 --- a/doc/man/nvme_subsystem_next_ctrl.2 +++ b/doc/man/nvme_subsystem_next_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_next_ctrl" 9 "nvme_subsystem_next_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_next_ctrl" 9 "nvme_subsystem_next_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_next_ctrl \- Next ctrl iterator .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_next_ns.2 b/doc/man/nvme_subsystem_next_ns.2 index fad424e..0a266ea 100644 --- a/doc/man/nvme_subsystem_next_ns.2 +++ b/doc/man/nvme_subsystem_next_ns.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_next_ns" 9 "nvme_subsystem_next_ns" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_next_ns" 9 "nvme_subsystem_next_ns" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_next_ns \- Next namespace iterator .SH SYNOPSIS diff --git a/doc/man/nvme_subsystem_reset.2 b/doc/man/nvme_subsystem_reset.2 index 6f96dcf..80769a0 100644 --- a/doc/man/nvme_subsystem_reset.2 +++ b/doc/man/nvme_subsystem_reset.2 @@ -1,4 +1,4 @@ -.TH "nvme_subsystem_reset" 9 "nvme_subsystem_reset" "April 2022" "libnvme API manual" LINUX +.TH "nvme_subsystem_reset" 9 "nvme_subsystem_reset" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_subsystem_reset \- Initiate a subsystem reset .SH SYNOPSIS diff --git a/doc/man/nvme_supported_cap_config_list_log.2 b/doc/man/nvme_supported_cap_config_list_log.2 index b842e36..cbf92ab 100644 --- a/doc/man/nvme_supported_cap_config_list_log.2 +++ b/doc/man/nvme_supported_cap_config_list_log.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_supported_cap_config_list_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_supported_cap_config_list_log" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_supported_cap_config_list_log \- +struct nvme_supported_cap_config_list_log \- Supported Capacity Configuration list log page .SH SYNOPSIS struct nvme_supported_cap_config_list_log { .br @@ -16,7 +16,9 @@ struct nvme_supported_cap_config_list_log { .SH Members .IP "sccn" 12 -number of capacity configuration -.SH "Description" -Supported Capacity Configuration list log page -structure definitions +Number of capacity configuration +.IP "rsvd1" 12 +Reserved +.IP "cap_config_desc" 12 +Capacity configuration descriptor. +See \fIstruct\fP nvme_capacity_config_desc diff --git a/doc/man/nvme_supported_log_pages.2 b/doc/man/nvme_supported_log_pages.2 index 4ff8d55..9912e20 100644 --- a/doc/man/nvme_supported_log_pages.2 +++ b/doc/man/nvme_supported_log_pages.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_supported_log_pages" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_supported_log_pages" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_supported_log_pages \- +struct nvme_supported_log_pages \- Supported Log Pages - Log .SH SYNOPSIS struct nvme_supported_log_pages { .br diff --git a/doc/man/nvme_telemetry_da.2 b/doc/man/nvme_telemetry_da.2 index 7ba72d7..6a6199f 100644 --- a/doc/man/nvme_telemetry_da.2 +++ b/doc/man/nvme_telemetry_da.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvme_telemetry_da" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_telemetry_da" "July 2022" "API Manual" LINUX .SH NAME enum nvme_telemetry_da \- Telemetry Log Data Area .SH SYNOPSIS diff --git a/doc/man/nvme_telemetry_log.2 b/doc/man/nvme_telemetry_log.2 index 4ee5d67..6fb11b0 100644 --- a/doc/man/nvme_telemetry_log.2 +++ b/doc/man/nvme_telemetry_log.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_telemetry_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_telemetry_log" "July 2022" "API Manual" LINUX .SH NAME struct nvme_telemetry_log \- Retrieve internal data specific to the manufacturer. .SH SYNOPSIS @@ -77,7 +77,7 @@ Telemetry Controller-Initiated Data Generation Number is a value that is incremented each time the controller initiates a capture of its internal controller state in the controller . .IP "rsnident" 12 -Reason Identifieris a vendor specific identifier that describes +Reason Identifiers a vendor specific identifier that describes the operating conditions of the controller at the time of capture. .IP "data_area" 12 diff --git a/doc/man/nvme_thermal_exc_event.2 b/doc/man/nvme_thermal_exc_event.2 index a50ff57..d98b429 100644 --- a/doc/man/nvme_thermal_exc_event.2 +++ b/doc/man/nvme_thermal_exc_event.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_thermal_exc_event" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_thermal_exc_event" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_thermal_exc_event \- +struct nvme_thermal_exc_event \- Thermal Excursion Event Data .SH SYNOPSIS struct nvme_thermal_exc_event { .br diff --git a/doc/man/nvme_time_stamp_change_event.2 b/doc/man/nvme_time_stamp_change_event.2 index 3a01771..36916bd 100644 --- a/doc/man/nvme_time_stamp_change_event.2 +++ b/doc/man/nvme_time_stamp_change_event.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_time_stamp_change_event" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_time_stamp_change_event" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_time_stamp_change_event \- +struct nvme_time_stamp_change_event \- Timestamp Change Event .SH SYNOPSIS struct nvme_time_stamp_change_event { .br diff --git a/doc/man/nvme_timestamp.2 b/doc/man/nvme_timestamp.2 index 97d6ee3..c161ebc 100644 --- a/doc/man/nvme_timestamp.2 +++ b/doc/man/nvme_timestamp.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_timestamp" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_timestamp" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_timestamp \- +struct nvme_timestamp \- Timestamp - Data Structure for Get Features .SH SYNOPSIS struct nvme_timestamp { .br diff --git a/doc/man/nvme_unlink_ctrl.2 b/doc/man/nvme_unlink_ctrl.2 index 8ef69e8..eef6c85 100644 --- a/doc/man/nvme_unlink_ctrl.2 +++ b/doc/man/nvme_unlink_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_unlink_ctrl" 9 "nvme_unlink_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_unlink_ctrl" 9 "nvme_unlink_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_unlink_ctrl \- Unlink controller .SH SYNOPSIS diff --git a/doc/man/nvme_update_config.2 b/doc/man/nvme_update_config.2 index c3357e2..f1feba1 100644 --- a/doc/man/nvme_update_config.2 +++ b/doc/man/nvme_update_config.2 @@ -1,4 +1,4 @@ -.TH "nvme_update_config" 9 "nvme_update_config" "April 2022" "libnvme API manual" LINUX +.TH "nvme_update_config" 9 "nvme_update_config" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_update_config \- Update JSON configuration .SH SYNOPSIS diff --git a/doc/man/nvme_uring_cmd.2 b/doc/man/nvme_uring_cmd.2 new file mode 100644 index 0000000..e36a0e6 --- /dev/null +++ b/doc/man/nvme_uring_cmd.2 @@ -0,0 +1,83 @@ +.TH "libnvme" 9 "struct nvme_uring_cmd" "July 2022" "API Manual" LINUX +.SH NAME +struct nvme_uring_cmd \- nvme uring command structure +.SH SYNOPSIS +struct nvme_uring_cmd { +.br +.BI " __u8 opcode;" +.br +.BI " __u8 flags;" +.br +.BI " __u16 rsvd1;" +.br +.BI " __u32 nsid;" +.br +.BI " __u32 cdw2;" +.br +.BI " __u32 cdw3;" +.br +.BI " __u64 metadata;" +.br +.BI " __u64 addr;" +.br +.BI " __u32 metadata_len;" +.br +.BI " __u32 data_len;" +.br +.BI " __u32 cdw10;" +.br +.BI " __u32 cdw11;" +.br +.BI " __u32 cdw12;" +.br +.BI " __u32 cdw13;" +.br +.BI " __u32 cdw14;" +.br +.BI " __u32 cdw15;" +.br +.BI " __u32 timeout_ms;" +.br +.BI " __u32 rsvd2;" +.br +.BI " +}; +.br + +.SH Members +.IP "opcode" 12 +Operation code, see \fIenum nvme_io_opcodes\fP and \fIenum nvme_admin_opcodes\fP +.IP "flags" 12 +Not supported: intended for command flags (eg: SGL, FUSE) +.IP "rsvd1" 12 +Reserved for future use +.IP "nsid" 12 +Namespace Identifier, or Fabrics type +.IP "cdw2" 12 +Command Dword 2 (no spec defined use) +.IP "cdw3" 12 +Command Dword 3 (no spec defined use) +.IP "metadata" 12 +User space address to metadata buffer (NULL if not used) +.IP "addr" 12 +User space address to data buffer (NULL if not used) +.IP "metadata_len" 12 +Metadata buffer transfer length +.IP "data_len" 12 +Data buffer transfer length +.IP "cdw10" 12 +Command Dword 10 (command specific) +.IP "cdw11" 12 +Command Dword 11 (command specific) +.IP "cdw12" 12 +Command Dword 12 (command specific) +.IP "cdw13" 12 +Command Dword 13 (command specific) +.IP "cdw14" 12 +Command Dword 14 (command specific) +.IP "cdw15" 12 +Command Dword 15 (command specific) +.IP "timeout_ms" 12 +If non-zero, overrides system default timeout in milliseconds +.IP "rsvd2" 12 +Reserved for future use (and fills an implicit struct pad diff --git a/doc/man/nvme_verify.2 b/doc/man/nvme_verify.2 index 000ae7f..170267f 100644 --- a/doc/man/nvme_verify.2 +++ b/doc/man/nvme_verify.2 @@ -1,4 +1,4 @@ -.TH "nvme_verify" 9 "nvme_verify" "April 2022" "libnvme API manual" LINUX +.TH "nvme_verify" 9 "nvme_verify" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_verify \- Send an nvme verify command .SH SYNOPSIS diff --git a/doc/man/nvme_version.2 b/doc/man/nvme_version.2 new file mode 100644 index 0000000..aae7fee --- /dev/null +++ b/doc/man/nvme_version.2 @@ -0,0 +1,18 @@ +.TH "libnvme" 9 "enum nvme_version" "July 2022" "API Manual" LINUX +.SH NAME +enum nvme_version \- Selector for version to be returned by @nvme_get_version +.SH SYNOPSIS +enum nvme_version { +.br +.BI " NVME_VERSION_PROJECT" +, +.br +.br +.BI " NVME_VERSION_GIT" + +}; +.SH Constants +.IP "NVME_VERSION_PROJECT" 12 +Project release version +.IP "NVME_VERSION_GIT" 12 +Git reference diff --git a/doc/man/nvme_virt_mgmt_act.2 b/doc/man/nvme_virt_mgmt_act.2 index a04cf35..0795832 100644 --- a/doc/man/nvme_virt_mgmt_act.2 +++ b/doc/man/nvme_virt_mgmt_act.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_virt_mgmt_act" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_virt_mgmt_act" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_virt_mgmt_act \- +enum nvme_virt_mgmt_act \- Virtualization Management - Action .SH SYNOPSIS enum nvme_virt_mgmt_act { .br diff --git a/doc/man/nvme_virt_mgmt_rt.2 b/doc/man/nvme_virt_mgmt_rt.2 index 99db5e0..3f9c612 100644 --- a/doc/man/nvme_virt_mgmt_rt.2 +++ b/doc/man/nvme_virt_mgmt_rt.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_virt_mgmt_rt" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_virt_mgmt_rt" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_virt_mgmt_rt \- +enum nvme_virt_mgmt_rt \- Virtualization Management - Resource Type .SH SYNOPSIS enum nvme_virt_mgmt_rt { .br diff --git a/doc/man/nvme_virtual_mgmt.2 b/doc/man/nvme_virtual_mgmt.2 index ece162d..a43ff0f 100644 --- a/doc/man/nvme_virtual_mgmt.2 +++ b/doc/man/nvme_virtual_mgmt.2 @@ -1,4 +1,4 @@ -.TH "nvme_virtual_mgmt" 9 "nvme_virtual_mgmt" "April 2022" "libnvme API manual" LINUX +.TH "nvme_virtual_mgmt" 9 "nvme_virtual_mgmt" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_virtual_mgmt \- Virtualization resource management .SH SYNOPSIS diff --git a/doc/man/nvme_virtual_mgmt_args.2 b/doc/man/nvme_virtual_mgmt_args.2 deleted file mode 100644 index d072b4c..0000000 --- a/doc/man/nvme_virtual_mgmt_args.2 +++ /dev/null @@ -1,43 +0,0 @@ -.TH "libnvme" 9 "struct nvme_virtual_mgmt_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_virtual_mgmt_args \- Arguments for the NVMe Virtualization resource management command -.SH SYNOPSIS -struct nvme_virtual_mgmt_args { -.br -.BI " __u32 *result;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " enum nvme_virt_mgmt_act act;" -.br -.BI " enum nvme_virt_mgmt_rt rt;" -.br -.BI " __u16 cntlid;" -.br -.BI " __u16 nr;" -.br -.BI " -}; -.br - -.SH Members -.IP "result" 12 -If successful, the CQE dword0 -.IP "args_size" 12 -Size of \fIstruct nvme_virtual_mgmt_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "act" 12 -Virtual resource action, see \fIenum nvme_virt_mgmt_act\fP -.IP "rt" 12 -Resource type to modify, see \fIenum nvme_virt_mgmt_rt\fP -.IP "cntlid" 12 -Controller id for which resources are bing modified -.IP "nr" 12 -Number of resources being allocated or assigned diff --git a/doc/man/nvme_write.2 b/doc/man/nvme_write.2 index ca701a9..6b7eb63 100644 --- a/doc/man/nvme_write.2 +++ b/doc/man/nvme_write.2 @@ -1,4 +1,4 @@ -.TH "nvme_write" 9 "nvme_write" "April 2022" "libnvme API manual" LINUX +.TH "nvme_write" 9 "nvme_write" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_write \- Submit an nvme user write command .SH SYNOPSIS diff --git a/doc/man/nvme_write_uncorrectable.2 b/doc/man/nvme_write_uncorrectable.2 index 018f526..6b67c0a 100644 --- a/doc/man/nvme_write_uncorrectable.2 +++ b/doc/man/nvme_write_uncorrectable.2 @@ -1,4 +1,4 @@ -.TH "nvme_write_uncorrectable" 9 "nvme_write_uncorrectable" "April 2022" "libnvme API manual" LINUX +.TH "nvme_write_uncorrectable" 9 "nvme_write_uncorrectable" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_write_uncorrectable \- Submit an nvme write uncorrectable command .SH SYNOPSIS diff --git a/doc/man/nvme_write_zeros.2 b/doc/man/nvme_write_zeros.2 index 26f17e0..0fb3ce8 100644 --- a/doc/man/nvme_write_zeros.2 +++ b/doc/man/nvme_write_zeros.2 @@ -1,4 +1,4 @@ -.TH "nvme_write_zeros" 9 "nvme_write_zeros" "April 2022" "libnvme API manual" LINUX +.TH "nvme_write_zeros" 9 "nvme_write_zeros" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_write_zeros \- Submit an nvme write zeroes command .SH SYNOPSIS diff --git a/doc/man/nvme_zns_append.2 b/doc/man/nvme_zns_append.2 index ee381ea..eb0d414 100644 --- a/doc/man/nvme_zns_append.2 +++ b/doc/man/nvme_zns_append.2 @@ -1,4 +1,4 @@ -.TH "nvme_zns_append" 9 "nvme_zns_append" "April 2022" "libnvme API manual" LINUX +.TH "nvme_zns_append" 9 "nvme_zns_append" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_zns_append \- Append data to a zone .SH SYNOPSIS diff --git a/doc/man/nvme_zns_append_args.2 b/doc/man/nvme_zns_append_args.2 deleted file mode 100644 index 7c87dce..0000000 --- a/doc/man/nvme_zns_append_args.2 +++ /dev/null @@ -1,70 +0,0 @@ -.TH "libnvme" 9 "struct nvme_zns_append_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_zns_append_args \- Arguments for the NVMe ZNS Append command -.SH SYNOPSIS -struct nvme_zns_append_args { -.br -.BI " __u64 zslba;" -.br -.BI " __u64 *result;" -.br -.BI " void *data;" -.br -.BI " void *metadata;" -.br -.BI " int args_size;" -.br -.BI " int fd;" -.br -.BI " __u32 timeout;" -.br -.BI " __u32 nsid;" -.br -.BI " __u32 ilbrt;" -.br -.BI " __u32 data_len;" -.br -.BI " __u32 metadata_len;" -.br -.BI " __u16 nlb;" -.br -.BI " __u16 control;" -.br -.BI " __u16 lbat;" -.br -.BI " __u16 lbatm;" -.br -.BI " -}; -.br - -.SH Members -.IP "zslba" 12 -Zone start logical block address -.IP "result" 12 -The command completion result from CQE dword0 -.IP "data" 12 -Userspace address of the data -.IP "metadata" 12 -Userspace address of the metadata -.IP "args_size" 12 -Size of \fIstruct nvme_zns_append_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -Timeout in ms -.IP "nsid" 12 -Namespace ID -.IP "ilbrt" 12 -Initial logical block reference tag -.IP "data_len" 12 -Length of \fIdata\fP -.IP "metadata_len" 12 -Length of \fImetadata\fP -.IP "nlb" 12 -Number of logical blocks -.IP "control" 12 -.IP "lbat" 12 -Logical block application tag -.IP "lbatm" 12 -Logical block application tag mask diff --git a/doc/man/nvme_zns_changed_zone_log.2 b/doc/man/nvme_zns_changed_zone_log.2 index 31a9aef..a901f7d 100644 --- a/doc/man/nvme_zns_changed_zone_log.2 +++ b/doc/man/nvme_zns_changed_zone_log.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_zns_changed_zone_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_zns_changed_zone_log" "July 2022" "API Manual" LINUX .SH NAME struct nvme_zns_changed_zone_log \- ZNS Changed Zone List log .SH SYNOPSIS diff --git a/doc/man/nvme_zns_desc.2 b/doc/man/nvme_zns_desc.2 index 06bc3a4..e299549 100644 --- a/doc/man/nvme_zns_desc.2 +++ b/doc/man/nvme_zns_desc.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_zns_desc" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_zns_desc" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_zns_desc \- +struct nvme_zns_desc \- Zone Descriptor Data Structure .SH SYNOPSIS struct nvme_zns_desc { .br diff --git a/doc/man/nvme_zns_id_ctrl.2 b/doc/man/nvme_zns_id_ctrl.2 index fc0898f..0c59364 100644 --- a/doc/man/nvme_zns_id_ctrl.2 +++ b/doc/man/nvme_zns_id_ctrl.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_zns_id_ctrl" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_zns_id_ctrl" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_zns_id_ctrl \- +struct nvme_zns_id_ctrl \- I/O Command Set Specific Identify Controller Data Structure for the Zoned Namespace Command Set .SH SYNOPSIS struct nvme_zns_id_ctrl { .br @@ -14,5 +14,6 @@ struct nvme_zns_id_ctrl { .SH Members .IP "zasl" 12 +Zone Append Size Limit .IP "rsvd1" 12 Reserved diff --git a/doc/man/nvme_zns_id_ns.2 b/doc/man/nvme_zns_id_ns.2 index 4e9ac06..176247d 100644 --- a/doc/man/nvme_zns_id_ns.2 +++ b/doc/man/nvme_zns_id_ns.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvme_zns_id_ns" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_zns_id_ns" "July 2022" "API Manual" LINUX .SH NAME struct nvme_zns_id_ns \- Zoned Namespace Command Set Specific Identify Namespace Data Structure .SH SYNOPSIS diff --git a/doc/man/nvme_zns_identify_ctrl.2 b/doc/man/nvme_zns_identify_ctrl.2 index bf3ebd3..d6b7b80 100644 --- a/doc/man/nvme_zns_identify_ctrl.2 +++ b/doc/man/nvme_zns_identify_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvme_zns_identify_ctrl" 9 "nvme_zns_identify_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvme_zns_identify_ctrl" 9 "nvme_zns_identify_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_zns_identify_ctrl \- ZNS identify controller data .SH SYNOPSIS diff --git a/doc/man/nvme_zns_identify_ns.2 b/doc/man/nvme_zns_identify_ns.2 index 4b95bb9..55618b2 100644 --- a/doc/man/nvme_zns_identify_ns.2 +++ b/doc/man/nvme_zns_identify_ns.2 @@ -1,4 +1,4 @@ -.TH "nvme_zns_identify_ns" 9 "nvme_zns_identify_ns" "April 2022" "libnvme API manual" LINUX +.TH "nvme_zns_identify_ns" 9 "nvme_zns_identify_ns" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_zns_identify_ns \- ZNS identify namespace data .SH SYNOPSIS diff --git a/doc/man/nvme_zns_lbafe.2 b/doc/man/nvme_zns_lbafe.2 index 846d775..7db1249 100644 --- a/doc/man/nvme_zns_lbafe.2 +++ b/doc/man/nvme_zns_lbafe.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_zns_lbafe" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_zns_lbafe" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_zns_lbafe \- +struct nvme_zns_lbafe \- LBA Format Extension Data Structure .SH SYNOPSIS struct nvme_zns_lbafe { .br diff --git a/doc/man/nvme_zns_mgmt_recv.2 b/doc/man/nvme_zns_mgmt_recv.2 index 222d828..8227a75 100644 --- a/doc/man/nvme_zns_mgmt_recv.2 +++ b/doc/man/nvme_zns_mgmt_recv.2 @@ -1,6 +1,6 @@ -.TH "nvme_zns_mgmt_recv" 9 "nvme_zns_mgmt_recv" "April 2022" "libnvme API manual" LINUX +.TH "nvme_zns_mgmt_recv" 9 "nvme_zns_mgmt_recv" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_zns_mgmt_recv \- +nvme_zns_mgmt_recv \- ZNS management receive command .SH SYNOPSIS .B "int" nvme_zns_mgmt_recv .BI "(struct nvme_zns_mgmt_recv_args *args " ");" diff --git a/doc/man/nvme_zns_mgmt_recv_args.2 b/doc/man/nvme_zns_mgmt_recv_args.2 deleted file mode 100644 index 556b136..0000000 --- a/doc/man/nvme_zns_mgmt_recv_args.2 +++ /dev/null @@ -1,55 +0,0 @@ -.TH "libnvme" 9 "struct nvme_zns_mgmt_recv_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_zns_mgmt_recv_args \- Arguments for the NVMe ZNS Management Receive command -.SH SYNOPSIS -struct nvme_zns_mgmt_recv_args { -.br -.BI " __u64 slba;" -.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_zns_recv_action zra;" -.br -.BI " __u32 data_len;" -.br -.BI " __u16 zrasf;" -.br -.BI " bool zras_feat;" -.br -.BI " -}; -.br - -.SH Members -.IP "slba" 12 -Starting logical block address -.IP "result" 12 -The command completion result from CQE dword0 -.IP "data" 12 -Userspace address of the data -.IP "args_size" 12 -Size of \fIstruct nvme_zns_mgmt_recv_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -timeout in ms -.IP "nsid" 12 -Namespace ID -.IP "zra" 12 -zone receive action -.IP "data_len" 12 -Length of \fIdata\fP -.IP "zrasf" 12 -Zone receive action specific field -.IP "zras_feat" 12 -Zone receive action specific features diff --git a/doc/man/nvme_zns_mgmt_send.2 b/doc/man/nvme_zns_mgmt_send.2 index e91a032..6875aac 100644 --- a/doc/man/nvme_zns_mgmt_send.2 +++ b/doc/man/nvme_zns_mgmt_send.2 @@ -1,6 +1,6 @@ -.TH "nvme_zns_mgmt_send" 9 "nvme_zns_mgmt_send" "April 2022" "libnvme API manual" LINUX +.TH "nvme_zns_mgmt_send" 9 "nvme_zns_mgmt_send" "July 2022" "libnvme API manual" LINUX .SH NAME -nvme_zns_mgmt_send \- +nvme_zns_mgmt_send \- ZNS management send command .SH SYNOPSIS .B "int" nvme_zns_mgmt_send .BI "(struct nvme_zns_mgmt_send_args *args " ");" diff --git a/doc/man/nvme_zns_mgmt_send_args.2 b/doc/man/nvme_zns_mgmt_send_args.2 deleted file mode 100644 index 0b1b53c..0000000 --- a/doc/man/nvme_zns_mgmt_send_args.2 +++ /dev/null @@ -1,55 +0,0 @@ -.TH "libnvme" 9 "struct nvme_zns_mgmt_send_args" "April 2022" "API Manual" LINUX -.SH NAME -struct nvme_zns_mgmt_send_args \- Arguments for the NVMe ZNS Management Send command -.SH SYNOPSIS -struct nvme_zns_mgmt_send_args { -.br -.BI " __u64 slba;" -.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_zns_send_action zsa;" -.br -.BI " __u32 data_len;" -.br -.BI " bool select_all;" -.br -.BI " __u8 zsaso;" -.br -.BI " -}; -.br - -.SH Members -.IP "slba" 12 -Starting logical block address -.IP "result" 12 -The command completion result from CQE dword0 -.IP "data" 12 -Userspace address of the data -.IP "args_size" 12 -Size of \fIstruct nvme_zns_mgmt_send_args\fP -.IP "fd" 12 -File descriptor of nvme device -.IP "timeout" 12 -timeout in ms -.IP "nsid" 12 -Namespace ID -.IP "zsa" 12 -Zone send action -.IP "data_len" 12 -Length of \fIdata\fP -.IP "select_all" 12 -Select all flag -.IP "zsaso" 12 -Zone Send Action Specific Option diff --git a/doc/man/nvme_zns_recv_action.2 b/doc/man/nvme_zns_recv_action.2 index a14d83e..1082f5d 100644 --- a/doc/man/nvme_zns_recv_action.2 +++ b/doc/man/nvme_zns_recv_action.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_zns_recv_action" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_zns_recv_action" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_zns_recv_action \- +enum nvme_zns_recv_action \- Zone Management Receive - Zone Receive Action Specific Features .SH SYNOPSIS enum nvme_zns_recv_action { .br diff --git a/doc/man/nvme_zns_report_options.2 b/doc/man/nvme_zns_report_options.2 index f938ffd..037010c 100644 --- a/doc/man/nvme_zns_report_options.2 +++ b/doc/man/nvme_zns_report_options.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_zns_report_options" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_zns_report_options" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_zns_report_options \- +enum nvme_zns_report_options \- Zone Management Receive - Zone Receive Action Specific Field .SH SYNOPSIS enum nvme_zns_report_options { .br diff --git a/doc/man/nvme_zns_report_zones.2 b/doc/man/nvme_zns_report_zones.2 index 6d61605..586f904 100644 --- a/doc/man/nvme_zns_report_zones.2 +++ b/doc/man/nvme_zns_report_zones.2 @@ -1,4 +1,4 @@ -.TH "nvme_zns_report_zones" 9 "nvme_zns_report_zones" "April 2022" "libnvme API manual" LINUX +.TH "nvme_zns_report_zones" 9 "nvme_zns_report_zones" "July 2022" "libnvme API manual" LINUX .SH NAME nvme_zns_report_zones \- Return the list of zones .SH SYNOPSIS diff --git a/doc/man/nvme_zns_send_action.2 b/doc/man/nvme_zns_send_action.2 index 0c13f63..ee4c419 100644 --- a/doc/man/nvme_zns_send_action.2 +++ b/doc/man/nvme_zns_send_action.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_zns_send_action" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_zns_send_action" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_zns_send_action \- +enum nvme_zns_send_action \- Zone Management Send - Zone Send Action .SH SYNOPSIS enum nvme_zns_send_action { .br diff --git a/doc/man/nvme_zns_za.2 b/doc/man/nvme_zns_za.2 index ab9cb27..25ed00c 100644 --- a/doc/man/nvme_zns_za.2 +++ b/doc/man/nvme_zns_za.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_zns_za" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_zns_za" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_zns_za \- +enum nvme_zns_za \- Zone Descriptor Data Structure .SH SYNOPSIS enum nvme_zns_za { .br diff --git a/doc/man/nvme_zns_zs.2 b/doc/man/nvme_zns_zs.2 index ee0d193..483af75 100644 --- a/doc/man/nvme_zns_zs.2 +++ b/doc/man/nvme_zns_zs.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_zns_zs" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_zns_zs" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_zns_zs \- +enum nvme_zns_zs \- Zone Descriptor Data Structure - Zone State .SH SYNOPSIS enum nvme_zns_zs { .br diff --git a/doc/man/nvme_zns_zt.2 b/doc/man/nvme_zns_zt.2 index 97b1291..342db2d 100644 --- a/doc/man/nvme_zns_zt.2 +++ b/doc/man/nvme_zns_zt.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "enum nvme_zns_zt" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvme_zns_zt" "July 2022" "API Manual" LINUX .SH NAME -enum nvme_zns_zt \- +enum nvme_zns_zt \- Zone Descriptor Data Structure - Zone Type .SH SYNOPSIS enum nvme_zns_zt { .br @@ -9,3 +9,4 @@ enum nvme_zns_zt { }; .SH Constants .IP "NVME_ZONE_TYPE_SEQWRITE_REQ" 12 +Sequential Write Required diff --git a/doc/man/nvme_zone_report.2 b/doc/man/nvme_zone_report.2 index 26a3495..23c2a35 100644 --- a/doc/man/nvme_zone_report.2 +++ b/doc/man/nvme_zone_report.2 @@ -1,6 +1,6 @@ -.TH "libnvme" 9 "struct nvme_zone_report" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvme_zone_report" "July 2022" "API Manual" LINUX .SH NAME -struct nvme_zone_report \- +struct nvme_zone_report \- Report Zones Data Structure .SH SYNOPSIS struct nvme_zone_report { .br diff --git a/doc/man/nvmf_add_ctrl.2 b/doc/man/nvmf_add_ctrl.2 index d4ac1ac..65d2cf6 100644 --- a/doc/man/nvmf_add_ctrl.2 +++ b/doc/man/nvmf_add_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvmf_add_ctrl" 9 "nvmf_add_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_add_ctrl" 9 "nvmf_add_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_add_ctrl \- Connect a controller and update topology .SH SYNOPSIS diff --git a/doc/man/nvmf_addr_family.2 b/doc/man/nvmf_addr_family.2 index 333509c..d19c24b 100644 --- a/doc/man/nvmf_addr_family.2 +++ b/doc/man/nvmf_addr_family.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_addr_family" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_addr_family" "July 2022" "API Manual" LINUX .SH NAME enum nvmf_addr_family \- Address Family codes for Discovery Log Page entry ADRFAM field .SH SYNOPSIS diff --git a/doc/man/nvmf_adrfam_str.2 b/doc/man/nvmf_adrfam_str.2 index d58dc90..1d3de9e 100644 --- a/doc/man/nvmf_adrfam_str.2 +++ b/doc/man/nvmf_adrfam_str.2 @@ -1,4 +1,4 @@ -.TH "nvmf_adrfam_str" 9 "nvmf_adrfam_str" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_adrfam_str" 9 "nvmf_adrfam_str" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_adrfam_str \- Decode ADRFAM field .SH SYNOPSIS diff --git a/doc/man/nvmf_cms_str.2 b/doc/man/nvmf_cms_str.2 index dffcf85..7166f9c 100644 --- a/doc/man/nvmf_cms_str.2 +++ b/doc/man/nvmf_cms_str.2 @@ -1,4 +1,4 @@ -.TH "nvmf_cms_str" 9 "nvmf_cms_str" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_cms_str" 9 "nvmf_cms_str" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_cms_str \- Decode RDMA connection management service field .SH SYNOPSIS diff --git a/doc/man/nvmf_connect_data.2 b/doc/man/nvmf_connect_data.2 index 6164c0a..3c466b3 100644 --- a/doc/man/nvmf_connect_data.2 +++ b/doc/man/nvmf_connect_data.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvmf_connect_data" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvmf_connect_data" "July 2022" "API Manual" LINUX .SH NAME struct nvmf_connect_data \- Data payload for the 'connect' command .SH SYNOPSIS diff --git a/doc/man/nvmf_connect_disc_entry.2 b/doc/man/nvmf_connect_disc_entry.2 index dd15474..6248a27 100644 --- a/doc/man/nvmf_connect_disc_entry.2 +++ b/doc/man/nvmf_connect_disc_entry.2 @@ -1,4 +1,4 @@ -.TH "nvmf_connect_disc_entry" 9 "nvmf_connect_disc_entry" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_connect_disc_entry" 9 "nvmf_connect_disc_entry" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_connect_disc_entry \- Connect controller based on the discovery log page entry .SH SYNOPSIS @@ -13,7 +13,7 @@ Host to which the controller should be connected .IP "e" 12 Discovery log page entry .IP "defcfg" 12 -Default configurationn to be used for the new controller +Default configuration to be used for the new controller .IP "discover" 12 Set to 'true' if the new controller is a discovery controller .SH "RETURN" diff --git a/doc/man/nvmf_default_config.2 b/doc/man/nvmf_default_config.2 index 3b958db..90d149f 100644 --- a/doc/man/nvmf_default_config.2 +++ b/doc/man/nvmf_default_config.2 @@ -1,4 +1,4 @@ -.TH "nvmf_default_config" 9 "nvmf_default_config" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_default_config" 9 "nvmf_default_config" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_default_config \- Default values for fabrics configuration .SH SYNOPSIS diff --git a/doc/man/nvmf_dim_data.2 b/doc/man/nvmf_dim_data.2 index 85d2be9..7e54b00 100644 --- a/doc/man/nvmf_dim_data.2 +++ b/doc/man/nvmf_dim_data.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvmf_dim_data" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvmf_dim_data" "July 2022" "API Manual" LINUX .SH NAME struct nvmf_dim_data \- Discovery Information Management (DIM) - Data .SH SYNOPSIS diff --git a/doc/man/nvmf_dim_entfmt.2 b/doc/man/nvmf_dim_entfmt.2 index b0903fd..cb7fb3b 100644 --- a/doc/man/nvmf_dim_entfmt.2 +++ b/doc/man/nvmf_dim_entfmt.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_dim_entfmt" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_dim_entfmt" "July 2022" "API Manual" LINUX .SH NAME enum nvmf_dim_entfmt \- Discovery Information Management Entry Format .SH SYNOPSIS diff --git a/doc/man/nvmf_dim_etype.2 b/doc/man/nvmf_dim_etype.2 index 4f3a9eb..8263ec1 100644 --- a/doc/man/nvmf_dim_etype.2 +++ b/doc/man/nvmf_dim_etype.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_dim_etype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_dim_etype" "July 2022" "API Manual" LINUX .SH NAME enum nvmf_dim_etype \- Discovery Information Management Entity Type .SH SYNOPSIS diff --git a/doc/man/nvmf_dim_tas.2 b/doc/man/nvmf_dim_tas.2 index 156a7da..99d3666 100644 --- a/doc/man/nvmf_dim_tas.2 +++ b/doc/man/nvmf_dim_tas.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_dim_tas" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_dim_tas" "July 2022" "API Manual" LINUX .SH NAME enum nvmf_dim_tas \- Discovery Information Management Task .SH SYNOPSIS diff --git a/doc/man/nvmf_disc_eflags.2 b/doc/man/nvmf_disc_eflags.2 index 60f4ba3..9eaffd8 100644 --- a/doc/man/nvmf_disc_eflags.2 +++ b/doc/man/nvmf_disc_eflags.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_disc_eflags" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_disc_eflags" "July 2022" "API Manual" LINUX .SH NAME enum nvmf_disc_eflags \- Discovery Log Page entry flags. .SH SYNOPSIS @@ -16,7 +16,7 @@ enum nvmf_disc_eflags { , .br .br -.BI " NVMF_DISC_EFLAGS_BOTH" +.BI " NVMF_DISC_EFLAGS_NCC" }; .SH Constants @@ -34,6 +34,13 @@ this flag set. Explicit Persistent Connection Support for Discovery (EPCSD): Indicates that Explicit Persistent Connections are supported for the Discovery controller. -.IP "NVMF_DISC_EFLAGS_BOTH" 12 -Indicates that both the DUPRETINFO and EPCSD -features are supported. +.IP "NVMF_DISC_EFLAGS_NCC" 12 +No CDC Connectivity (NCC): If set to +'1', then no DDC that describes this entry +is currently connected to the CDC. If +cleared to '0', then at least one DDC that +describes this entry is currently +connected to the CDC. If the Discovery +controller returning this log page is not +a CDC, then this bit shall be cleared to +'0' and should be ignored by the host. diff --git a/doc/man/nvmf_disc_log_entry.2 b/doc/man/nvmf_disc_log_entry.2 index 73ef858..f21c65b 100644 --- a/doc/man/nvmf_disc_log_entry.2 +++ b/doc/man/nvmf_disc_log_entry.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvmf_disc_log_entry" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvmf_disc_log_entry" "July 2022" "API Manual" LINUX .SH NAME struct nvmf_disc_log_entry \- Discovery Log Page entry .SH SYNOPSIS diff --git a/doc/man/nvmf_discovery_log.2 b/doc/man/nvmf_discovery_log.2 index f8707c1..f1aa742 100644 --- a/doc/man/nvmf_discovery_log.2 +++ b/doc/man/nvmf_discovery_log.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvmf_discovery_log" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvmf_discovery_log" "July 2022" "API Manual" LINUX .SH NAME struct nvmf_discovery_log \- Discovery Log Page (Log Identifier 70h) .SH SYNOPSIS diff --git a/doc/man/nvmf_eflags_str.2 b/doc/man/nvmf_eflags_str.2 index dbe1065..9ac5cb8 100644 --- a/doc/man/nvmf_eflags_str.2 +++ b/doc/man/nvmf_eflags_str.2 @@ -1,4 +1,4 @@ -.TH "nvmf_eflags_str" 9 "nvmf_eflags_str" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_eflags_str" 9 "nvmf_eflags_str" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_eflags_str \- Decode EFLAGS field .SH SYNOPSIS diff --git a/doc/man/nvmf_exat_len.2 b/doc/man/nvmf_exat_len.2 index 2daeaea..02dae1b 100644 --- a/doc/man/nvmf_exat_len.2 +++ b/doc/man/nvmf_exat_len.2 @@ -1,4 +1,4 @@ -.TH "nvmf_exat_len" 9 "nvmf_exat_len" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_exat_len" 9 "nvmf_exat_len" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_exat_len \- Return length rounded up by 4 .SH SYNOPSIS diff --git a/doc/man/nvmf_exattype.2 b/doc/man/nvmf_exattype.2 index 07d0a92..91c03dd 100644 --- a/doc/man/nvmf_exattype.2 +++ b/doc/man/nvmf_exattype.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_exattype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_exattype" "July 2022" "API Manual" LINUX .SH NAME enum nvmf_exattype \- Extended Attribute Type .SH SYNOPSIS diff --git a/doc/man/nvmf_ext_attr.2 b/doc/man/nvmf_ext_attr.2 index 4215edc..87b96b8 100644 --- a/doc/man/nvmf_ext_attr.2 +++ b/doc/man/nvmf_ext_attr.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvmf_ext_attr" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvmf_ext_attr" "July 2022" "API Manual" LINUX .SH NAME struct nvmf_ext_attr \- Extended Attribute (EXAT) .SH SYNOPSIS diff --git a/doc/man/nvmf_ext_die.2 b/doc/man/nvmf_ext_die.2 index 4d50926..76c1060 100644 --- a/doc/man/nvmf_ext_die.2 +++ b/doc/man/nvmf_ext_die.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "struct nvmf_ext_die" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "struct nvmf_ext_die" "July 2022" "API Manual" LINUX .SH NAME struct nvmf_ext_die \- Extended Discovery Information Entry (DIE) .SH SYNOPSIS @@ -76,4 +76,4 @@ Number of Extended Attributes .IP "resv1030" 12 Reserved .IP "exat" 12 -Extented Attributes 0 (\fIstruct nvmf_ext_attr\fP) +Extended Attributes 0 (\fIstruct nvmf_ext_attr\fP) diff --git a/doc/man/nvmf_get_discovery_log.2 b/doc/man/nvmf_get_discovery_log.2 index aee9c17..f60331a 100644 --- a/doc/man/nvmf_get_discovery_log.2 +++ b/doc/man/nvmf_get_discovery_log.2 @@ -1,4 +1,4 @@ -.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_get_discovery_log \- Return the discovery log page .SH SYNOPSIS @@ -8,7 +8,7 @@ nvmf_get_discovery_log \- Return the discovery log page .BI "int max_retries " ");" .SH ARGUMENTS .IP "c" 12 -Discover controller to use +Discover controller to use .IP "logp" 12 Pointer to the log page to be returned .IP "max_retries" 12 diff --git a/doc/man/nvmf_hostid_from_file.2 b/doc/man/nvmf_hostid_from_file.2 index 72e5002..5e82688 100644 --- a/doc/man/nvmf_hostid_from_file.2 +++ b/doc/man/nvmf_hostid_from_file.2 @@ -1,4 +1,4 @@ -.TH "nvmf_hostid_from_file" 9 "nvmf_hostid_from_file" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_hostid_from_file" 9 "nvmf_hostid_from_file" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_hostid_from_file \- Reads the host identifier from the config default location in /etc/nvme/. .SH SYNOPSIS diff --git a/doc/man/nvmf_hostnqn_from_file.2 b/doc/man/nvmf_hostnqn_from_file.2 index ce84ae5..d621633 100644 --- a/doc/man/nvmf_hostnqn_from_file.2 +++ b/doc/man/nvmf_hostnqn_from_file.2 @@ -1,4 +1,4 @@ -.TH "nvmf_hostnqn_from_file" 9 "nvmf_hostnqn_from_file" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_hostnqn_from_file" 9 "nvmf_hostnqn_from_file" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_hostnqn_from_file \- Reads the host nvm qualified name from the config default location in /etc/nvme/ .SH SYNOPSIS diff --git a/doc/man/nvmf_hostnqn_generate.2 b/doc/man/nvmf_hostnqn_generate.2 index baa5c12..c4dea93 100644 --- a/doc/man/nvmf_hostnqn_generate.2 +++ b/doc/man/nvmf_hostnqn_generate.2 @@ -1,4 +1,4 @@ -.TH "nvmf_hostnqn_generate" 9 "nvmf_hostnqn_generate" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_hostnqn_generate" 9 "nvmf_hostnqn_generate" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_hostnqn_generate \- Generate a machine specific host nqn .SH SYNOPSIS diff --git a/doc/man/nvmf_prtype_str.2 b/doc/man/nvmf_prtype_str.2 index fb33189..176c361 100644 --- a/doc/man/nvmf_prtype_str.2 +++ b/doc/man/nvmf_prtype_str.2 @@ -1,4 +1,4 @@ -.TH "nvmf_prtype_str" 9 "nvmf_prtype_str" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_prtype_str" 9 "nvmf_prtype_str" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_prtype_str \- Decode RDMA Provider type field .SH SYNOPSIS diff --git a/doc/man/nvmf_qptype_str.2 b/doc/man/nvmf_qptype_str.2 index f67f9f6..5184bf8 100644 --- a/doc/man/nvmf_qptype_str.2 +++ b/doc/man/nvmf_qptype_str.2 @@ -1,4 +1,4 @@ -.TH "nvmf_qptype_str" 9 "nvmf_qptype_str" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_qptype_str" 9 "nvmf_qptype_str" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_qptype_str \- Decode RDMA QP Service type field .SH SYNOPSIS diff --git a/doc/man/nvmf_rdma_cms.2 b/doc/man/nvmf_rdma_cms.2 index 0b4d2fe..d582a51 100644 --- a/doc/man/nvmf_rdma_cms.2 +++ b/doc/man/nvmf_rdma_cms.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_rdma_cms" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_rdma_cms" "July 2022" "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 diff --git a/doc/man/nvmf_rdma_prtype.2 b/doc/man/nvmf_rdma_prtype.2 index 997fe6d..6ab1188 100644 --- a/doc/man/nvmf_rdma_prtype.2 +++ b/doc/man/nvmf_rdma_prtype.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_rdma_prtype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_rdma_prtype" "July 2022" "API Manual" LINUX .SH NAME enum nvmf_rdma_prtype \- RDMA Provider Type codes for Discovery Log Page entry TSAS RDMA_PRTYPE field .SH SYNOPSIS diff --git a/doc/man/nvmf_rdma_qptype.2 b/doc/man/nvmf_rdma_qptype.2 index c6a01d7..a98972c 100644 --- a/doc/man/nvmf_rdma_qptype.2 +++ b/doc/man/nvmf_rdma_qptype.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_rdma_qptype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_rdma_qptype" "July 2022" "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 diff --git a/doc/man/nvmf_register_ctrl.2 b/doc/man/nvmf_register_ctrl.2 index 813cac6..3934f86 100644 --- a/doc/man/nvmf_register_ctrl.2 +++ b/doc/man/nvmf_register_ctrl.2 @@ -1,4 +1,4 @@ -.TH "nvmf_register_ctrl" 9 "nvmf_register_ctrl" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_register_ctrl" 9 "nvmf_register_ctrl" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_register_ctrl \- Perform registration task with a DC .SH SYNOPSIS diff --git a/doc/man/nvmf_sectype_str.2 b/doc/man/nvmf_sectype_str.2 index 8dc8515..df54e8a 100644 --- a/doc/man/nvmf_sectype_str.2 +++ b/doc/man/nvmf_sectype_str.2 @@ -1,4 +1,4 @@ -.TH "nvmf_sectype_str" 9 "nvmf_sectype_str" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_sectype_str" 9 "nvmf_sectype_str" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_sectype_str \- Decode SECTYPE field .SH SYNOPSIS diff --git a/doc/man/nvmf_subtype_str.2 b/doc/man/nvmf_subtype_str.2 index 1134736..5248d72 100644 --- a/doc/man/nvmf_subtype_str.2 +++ b/doc/man/nvmf_subtype_str.2 @@ -1,4 +1,4 @@ -.TH "nvmf_subtype_str" 9 "nvmf_subtype_str" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_subtype_str" 9 "nvmf_subtype_str" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_subtype_str \- Decode SUBTYPE field .SH SYNOPSIS diff --git a/doc/man/nvmf_tcp_sectype.2 b/doc/man/nvmf_tcp_sectype.2 index 770e684..5287b46 100644 --- a/doc/man/nvmf_tcp_sectype.2 +++ b/doc/man/nvmf_tcp_sectype.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_tcp_sectype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_tcp_sectype" "July 2022" "API Manual" LINUX .SH NAME enum nvmf_tcp_sectype \- Transport Specific Address Subtype Definition for NVMe/TCP Transport .SH SYNOPSIS diff --git a/doc/man/nvmf_treq.2 b/doc/man/nvmf_treq.2 index a1c01a1..036c731 100644 --- a/doc/man/nvmf_treq.2 +++ b/doc/man/nvmf_treq.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_treq" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_treq" "July 2022" "API Manual" LINUX .SH NAME enum nvmf_treq \- Transport Requirements codes for Discovery Log Page entry TREQ field .SH SYNOPSIS diff --git a/doc/man/nvmf_treq_str.2 b/doc/man/nvmf_treq_str.2 index 3c5e7c3..defe7e8 100644 --- a/doc/man/nvmf_treq_str.2 +++ b/doc/man/nvmf_treq_str.2 @@ -1,4 +1,4 @@ -.TH "nvmf_treq_str" 9 "nvmf_treq_str" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_treq_str" 9 "nvmf_treq_str" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_treq_str \- Decode TREQ field .SH SYNOPSIS diff --git a/doc/man/nvmf_trtype.2 b/doc/man/nvmf_trtype.2 index 7d00ca7..aa3aa88 100644 --- a/doc/man/nvmf_trtype.2 +++ b/doc/man/nvmf_trtype.2 @@ -1,4 +1,4 @@ -.TH "libnvme" 9 "enum nvmf_trtype" "April 2022" "API Manual" LINUX +.TH "libnvme" 9 "enum nvmf_trtype" "July 2022" "API Manual" LINUX .SH NAME enum nvmf_trtype \- Transport Type codes for Discovery Log Page entry TRTYPE field .SH SYNOPSIS diff --git a/doc/man/nvmf_trtype_str.2 b/doc/man/nvmf_trtype_str.2 index b46fe99..0c45e9e 100644 --- a/doc/man/nvmf_trtype_str.2 +++ b/doc/man/nvmf_trtype_str.2 @@ -1,4 +1,4 @@ -.TH "nvmf_trtype_str" 9 "nvmf_trtype_str" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_trtype_str" 9 "nvmf_trtype_str" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_trtype_str \- Decode TRTYPE field .SH SYNOPSIS diff --git a/doc/man/nvmf_update_config.2 b/doc/man/nvmf_update_config.2 index c23097b..0f4b5c4 100644 --- a/doc/man/nvmf_update_config.2 +++ b/doc/man/nvmf_update_config.2 @@ -1,4 +1,4 @@ -.TH "nvmf_update_config" 9 "nvmf_update_config" "April 2022" "libnvme API manual" LINUX +.TH "nvmf_update_config" 9 "nvmf_update_config" "July 2022" "libnvme API manual" LINUX .SH NAME nvmf_update_config \- Update fabrics configuration values .SH SYNOPSIS |