]> www.infradead.org Git - users/sagi/libnvme.git/commitdiff
doc: Regenerate all docs for v1.2 v1.2
authorDaniel Wagner <dwagner@suse.de>
Fri, 28 Oct 2022 17:23:49 +0000 (19:23 +0200)
committerDaniel Wagner <dwagner@suse.de>
Fri, 28 Oct 2022 17:23:49 +0000 (19:23 +0200)
Signed-off-by: Daniel Wagner <dwagner@suse.de>
722 files changed:
doc/conf.py
doc/config-schema.json
doc/man/nvme_admin_opcode.2
doc/man/nvme_admin_passthru.2
doc/man/nvme_admin_passthru64.2 [new file with mode: 0644]
doc/man/nvme_ae_info_css_nvm.2
doc/man/nvme_ae_info_error.2
doc/man/nvme_ae_info_notice.2
doc/man/nvme_ae_info_smart.2
doc/man/nvme_ae_type.2
doc/man/nvme_aggregate_endurance_group_event.2
doc/man/nvme_aggregate_predictable_lat_event.2
doc/man/nvme_ana_group_desc.2
doc/man/nvme_ana_log.2
doc/man/nvme_ana_state.2
doc/man/nvme_apst_entry.2
doc/man/nvme_boot_partition.2
doc/man/nvme_capacity_config_desc.2
doc/man/nvme_capacity_mgmt.2
doc/man/nvme_change_ns_event.2
doc/man/nvme_channel_config_desc.2
doc/man/nvme_cmb_size.2
doc/man/nvme_cmd_effects.2
doc/man/nvme_cmd_effects_log.2
doc/man/nvme_cmd_format_mset.2
doc/man/nvme_cmd_format_pi.2
doc/man/nvme_cmd_format_pil.2
doc/man/nvme_cmd_format_ses.2
doc/man/nvme_cmd_get_log_lid.2
doc/man/nvme_cmd_get_log_telemetry_host_lsp.2
doc/man/nvme_compare.2
doc/man/nvme_connect_err.2
doc/man/nvme_constants.2
doc/man/nvme_copy.2
doc/man/nvme_copy_range.2
doc/man/nvme_copy_range_f1.2 [new file with mode: 0644]
doc/man/nvme_create_ctrl.2
doc/man/nvme_create_root.2
doc/man/nvme_csi.2
doc/man/nvme_ctrl_first_ns.2
doc/man/nvme_ctrl_first_path.2
doc/man/nvme_ctrl_for_each_ns.2
doc/man/nvme_ctrl_for_each_ns_safe.2
doc/man/nvme_ctrl_for_each_path.2
doc/man/nvme_ctrl_for_each_path_safe.2
doc/man/nvme_ctrl_get_address.2
doc/man/nvme_ctrl_get_config.2
doc/man/nvme_ctrl_get_dhchap_host_key.2 [new file with mode: 0644]
doc/man/nvme_ctrl_get_dhchap_key.2
doc/man/nvme_ctrl_get_fd.2
doc/man/nvme_ctrl_get_firmware.2
doc/man/nvme_ctrl_get_host_iface.2
doc/man/nvme_ctrl_get_host_traddr.2
doc/man/nvme_ctrl_get_model.2
doc/man/nvme_ctrl_get_name.2
doc/man/nvme_ctrl_get_numa_node.2
doc/man/nvme_ctrl_get_queue_count.2
doc/man/nvme_ctrl_get_serial.2
doc/man/nvme_ctrl_get_sqsize.2
doc/man/nvme_ctrl_get_state.2
doc/man/nvme_ctrl_get_subsysnqn.2
doc/man/nvme_ctrl_get_subsystem.2
doc/man/nvme_ctrl_get_sysfs_dir.2
doc/man/nvme_ctrl_get_traddr.2
doc/man/nvme_ctrl_get_transport.2
doc/man/nvme_ctrl_get_trsvcid.2
doc/man/nvme_ctrl_identify.2
doc/man/nvme_ctrl_is_discovered.2
doc/man/nvme_ctrl_is_discovery_ctrl.2
doc/man/nvme_ctrl_is_persistent.2
doc/man/nvme_ctrl_list.2
doc/man/nvme_ctrl_metadata_type.2
doc/man/nvme_ctrl_next_ns.2
doc/man/nvme_ctrl_next_path.2
doc/man/nvme_ctrl_reset.2
doc/man/nvme_ctrl_set_dhchap_host_key.2 [new file with mode: 0644]
doc/man/nvme_ctrl_set_dhchap_key.2
doc/man/nvme_ctrl_set_discovered.2
doc/man/nvme_ctrl_set_discovery_ctrl.2
doc/man/nvme_ctrl_set_persistent.2
doc/man/nvme_ctrls_filter.2
doc/man/nvme_data_tfr.2 [new file with mode: 0644]
doc/man/nvme_default_host.2
doc/man/nvme_dev_self_test.2
doc/man/nvme_directive_dtype.2
doc/man/nvme_directive_receive_doper.2
doc/man/nvme_directive_recv.2
doc/man/nvme_directive_recv_identify_parameters.2
doc/man/nvme_directive_recv_stream_allocate.2
doc/man/nvme_directive_recv_stream_parameters.2
doc/man/nvme_directive_recv_stream_status.2
doc/man/nvme_directive_send.2
doc/man/nvme_directive_send_doper.2
doc/man/nvme_directive_send_id_endir.2
doc/man/nvme_directive_send_identify_endir.2
doc/man/nvme_directive_send_stream_release_identifier.2
doc/man/nvme_directive_send_stream_release_resource.2
doc/man/nvme_directive_types.2
doc/man/nvme_disconnect_ctrl.2
doc/man/nvme_dsm.2
doc/man/nvme_dsm_attributes.2
doc/man/nvme_dsm_range.2
doc/man/nvme_dst_stc.2
doc/man/nvme_dump_config.2
doc/man/nvme_dump_tree.2
doc/man/nvme_eg_critical_warning_flags.2
doc/man/nvme_eg_event_aggregate_log.2
doc/man/nvme_end_grp_chan_desc.2
doc/man/nvme_end_grp_config_desc.2
doc/man/nvme_endurance_group_log.2
doc/man/nvme_errno_to_string.2
doc/man/nvme_error_log_page.2
doc/man/nvme_fabrics_config.2
doc/man/nvme_fctype.2
doc/man/nvme_feat.2
doc/man/nvme_feat_auto_pst.2
doc/man/nvme_feat_host_behavior.2
doc/man/nvme_feat_nswpcfg_state.2
doc/man/nvme_feat_plm_window_select.2
doc/man/nvme_feat_resv_notify_flags.2
doc/man/nvme_feat_tmpthresh_thsel.2
doc/man/nvme_features_async_event_config_flags.2
doc/man/nvme_features_id.2
doc/man/nvme_fid_supported_effects.2
doc/man/nvme_fid_supported_effects_log.2
doc/man/nvme_firmware_slot.2
doc/man/nvme_first_host.2
doc/man/nvme_first_subsystem.2
doc/man/nvme_flush.2
doc/man/nvme_for_each_host.2
doc/man/nvme_for_each_host_safe.2
doc/man/nvme_for_each_subsystem.2
doc/man/nvme_for_each_subsystem_safe.2
doc/man/nvme_format_nvm.2
doc/man/nvme_format_nvm_compln_event.2
doc/man/nvme_format_nvm_start_event.2
doc/man/nvme_free_ctrl.2
doc/man/nvme_free_host.2
doc/man/nvme_free_ns.2
doc/man/nvme_free_subsystem.2
doc/man/nvme_free_tree.2
doc/man/nvme_fw_commit.2
doc/man/nvme_fw_commit_ca.2
doc/man/nvme_fw_commit_event.2
doc/man/nvme_fw_download.2
doc/man/nvme_fw_download_seq.2
doc/man/nvme_gen_dhchap_key.2
doc/man/nvme_get_ana_log_len.2
doc/man/nvme_get_attr.2
doc/man/nvme_get_ctrl_attr.2
doc/man/nvme_get_ctrl_telemetry.2
doc/man/nvme_get_directive_receive_length.2
doc/man/nvme_get_discovery_args.2 [new file with mode: 0644]
doc/man/nvme_get_feature_length.2
doc/man/nvme_get_feature_length2.2 [new file with mode: 0644]
doc/man/nvme_get_features.2
doc/man/nvme_get_features_arbitration.2
doc/man/nvme_get_features_async_event.2
doc/man/nvme_get_features_auto_pst.2
doc/man/nvme_get_features_data.2
doc/man/nvme_get_features_endurance_event_cfg.2
doc/man/nvme_get_features_err_recovery.2
doc/man/nvme_get_features_hctm.2
doc/man/nvme_get_features_host_behavior.2
doc/man/nvme_get_features_host_id.2
doc/man/nvme_get_features_host_mem_buf.2
doc/man/nvme_get_features_iocs_profile.2
doc/man/nvme_get_features_irq_coalesce.2
doc/man/nvme_get_features_irq_config.2
doc/man/nvme_get_features_kato.2
doc/man/nvme_get_features_lba_range.2
doc/man/nvme_get_features_lba_sts_interval.2
doc/man/nvme_get_features_nopsc.2
doc/man/nvme_get_features_num_queues.2
doc/man/nvme_get_features_plm_config.2
doc/man/nvme_get_features_plm_window.2
doc/man/nvme_get_features_power_mgmt.2
doc/man/nvme_get_features_resv_mask.2
doc/man/nvme_get_features_resv_persist.2
doc/man/nvme_get_features_rrl.2
doc/man/nvme_get_features_sanitize.2
doc/man/nvme_get_features_sel.2
doc/man/nvme_get_features_simple.2
doc/man/nvme_get_features_sw_progress.2
doc/man/nvme_get_features_temp_thresh.2
doc/man/nvme_get_features_timestamp.2
doc/man/nvme_get_features_volatile_wc.2
doc/man/nvme_get_features_write_atomic.2
doc/man/nvme_get_features_write_protect.2
doc/man/nvme_get_host_telemetry.2
doc/man/nvme_get_lba_status.2
doc/man/nvme_get_lba_status_log.2
doc/man/nvme_get_log.2
doc/man/nvme_get_log_ana.2
doc/man/nvme_get_log_ana_groups.2
doc/man/nvme_get_log_boot_partition.2
doc/man/nvme_get_log_changed_ns_list.2
doc/man/nvme_get_log_cmd_effects.2
doc/man/nvme_get_log_create_telemetry_host.2
doc/man/nvme_get_log_device_self_test.2
doc/man/nvme_get_log_discovery.2
doc/man/nvme_get_log_endurance_group.2
doc/man/nvme_get_log_endurance_grp_evt.2
doc/man/nvme_get_log_error.2
doc/man/nvme_get_log_fid_supported_effects.2
doc/man/nvme_get_log_fw_slot.2
doc/man/nvme_get_log_lba_status.2
doc/man/nvme_get_log_media_unit_stat.2
doc/man/nvme_get_log_mi_cmd_supported_effects.2
doc/man/nvme_get_log_page.2
doc/man/nvme_get_log_persistent_event.2
doc/man/nvme_get_log_predictable_lat_event.2
doc/man/nvme_get_log_predictable_lat_nvmset.2
doc/man/nvme_get_log_reservation.2
doc/man/nvme_get_log_sanitize.2
doc/man/nvme_get_log_smart.2
doc/man/nvme_get_log_support_cap_config_list.2
doc/man/nvme_get_log_supported_log_pages.2
doc/man/nvme_get_log_telemetry_ctrl.2
doc/man/nvme_get_log_telemetry_host.2
doc/man/nvme_get_log_zns_changed_zones.2
doc/man/nvme_get_logical_block_size.2
doc/man/nvme_get_new_host_telemetry.2
doc/man/nvme_get_ns_attr.2
doc/man/nvme_get_nsid.2
doc/man/nvme_get_path_attr.2
doc/man/nvme_get_property.2
doc/man/nvme_get_subsys_attr.2
doc/man/nvme_hmac_alg.2
doc/man/nvme_host_behavior_support.2
doc/man/nvme_host_get_dhchap_key.2
doc/man/nvme_host_get_hostid.2
doc/man/nvme_host_get_hostnqn.2
doc/man/nvme_host_get_hostsymname.2
doc/man/nvme_host_get_root.2
doc/man/nvme_host_mem_buf_attrs.2
doc/man/nvme_host_metadata.2
doc/man/nvme_host_set_dhchap_key.2
doc/man/nvme_host_set_hostsymname.2
doc/man/nvme_id_ctrl.2
doc/man/nvme_id_ctrl_anacap.2
doc/man/nvme_id_ctrl_apsta.2
doc/man/nvme_id_ctrl_avscc.2
doc/man/nvme_id_ctrl_cmic.2
doc/man/nvme_id_ctrl_cntrltype.2
doc/man/nvme_id_ctrl_cqes.2
doc/man/nvme_id_ctrl_ctratt.2
doc/man/nvme_id_ctrl_dctype.2
doc/man/nvme_id_ctrl_dsto.2
doc/man/nvme_id_ctrl_fcatt.2
doc/man/nvme_id_ctrl_fna.2
doc/man/nvme_id_ctrl_frmw.2
doc/man/nvme_id_ctrl_fuses.2
doc/man/nvme_id_ctrl_hctm.2
doc/man/nvme_id_ctrl_lpa.2
doc/man/nvme_id_ctrl_mec.2
doc/man/nvme_id_ctrl_nvm.2
doc/man/nvme_id_ctrl_nvmsr.2
doc/man/nvme_id_ctrl_nvscc.2
doc/man/nvme_id_ctrl_nwpc.2
doc/man/nvme_id_ctrl_oacs.2
doc/man/nvme_id_ctrl_oaes.2
doc/man/nvme_id_ctrl_ofcs.2
doc/man/nvme_id_ctrl_oncs.2
doc/man/nvme_id_ctrl_rpmbs.2
doc/man/nvme_id_ctrl_sanicap.2
doc/man/nvme_id_ctrl_sgls.2
doc/man/nvme_id_ctrl_sqes.2
doc/man/nvme_id_ctrl_vwc.2
doc/man/nvme_id_ctrl_vwci.2
doc/man/nvme_id_directives.2
doc/man/nvme_id_domain_attr.2
doc/man/nvme_id_domain_list.2
doc/man/nvme_id_endurance_group_list.2
doc/man/nvme_id_independent_id_ns.2
doc/man/nvme_id_iocs.2
doc/man/nvme_id_ns.2
doc/man/nvme_id_ns_attr.2
doc/man/nvme_id_ns_dlfeat.2
doc/man/nvme_id_ns_dpc.2
doc/man/nvme_id_ns_dps.2
doc/man/nvme_id_ns_flbas.2
doc/man/nvme_id_ns_granularity_desc.2
doc/man/nvme_id_ns_granularity_list.2
doc/man/nvme_id_ns_mc.2
doc/man/nvme_id_ns_nmic.2
doc/man/nvme_id_ns_rescap.2
doc/man/nvme_id_nsfeat.2
doc/man/nvme_id_nvmset_list.2
doc/man/nvme_id_psd.2
doc/man/nvme_id_uuid.2
doc/man/nvme_id_uuid_list.2
doc/man/nvme_id_uuid_list_entry.2
doc/man/nvme_identify.2
doc/man/nvme_identify_active_ns_list.2
doc/man/nvme_identify_active_ns_list_csi.2
doc/man/nvme_identify_allocated_ns.2
doc/man/nvme_identify_allocated_ns_list.2
doc/man/nvme_identify_allocated_ns_list_csi.2
doc/man/nvme_identify_cns.2
doc/man/nvme_identify_ctrl.2
doc/man/nvme_identify_ctrl_csi.2
doc/man/nvme_identify_ctrl_list.2
doc/man/nvme_identify_domain_list.2
doc/man/nvme_identify_endurance_group_list.2
doc/man/nvme_identify_independent_identify_ns.2
doc/man/nvme_identify_iocs.2
doc/man/nvme_identify_iocs_ns_csi_user_data_format.2
doc/man/nvme_identify_ns.2
doc/man/nvme_identify_ns_csi.2
doc/man/nvme_identify_ns_csi_user_data_format.2
doc/man/nvme_identify_ns_descs.2
doc/man/nvme_identify_ns_granularity.2
doc/man/nvme_identify_nsid_ctrl_list.2
doc/man/nvme_identify_nvmset_list.2
doc/man/nvme_identify_primary_ctrl.2
doc/man/nvme_identify_secondary_ctrl_list.2
doc/man/nvme_identify_uuid.2
doc/man/nvme_init_copy_range.2
doc/man/nvme_init_copy_range_f1.2 [new file with mode: 0644]
doc/man/nvme_init_ctrl.2
doc/man/nvme_init_ctrl_list.2
doc/man/nvme_init_dsm_range.2
doc/man/nvme_init_logging.2
doc/man/nvme_io.2
doc/man/nvme_io_control_flags.2
doc/man/nvme_io_dsm_flags.2
doc/man/nvme_io_opcode.2
doc/man/nvme_io_passthru.2
doc/man/nvme_io_passthru64.2 [new file with mode: 0644]
doc/man/nvme_is_64bit_reg.2 [new file with mode: 0644]
doc/man/nvme_lba_range_type.2
doc/man/nvme_lba_range_type_entry.2
doc/man/nvme_lba_rd.2
doc/man/nvme_lba_status.2
doc/man/nvme_lba_status_atype.2
doc/man/nvme_lba_status_desc.2
doc/man/nvme_lba_status_log.2
doc/man/nvme_lbaf.2
doc/man/nvme_lbaf_rp.2
doc/man/nvme_lbart.2
doc/man/nvme_lbas_ns_element.2
doc/man/nvme_lockdown.2
doc/man/nvme_log_ana_lsp.2
doc/man/nvme_lookup_ctrl.2
doc/man/nvme_lookup_host.2
doc/man/nvme_lookup_subsystem.2
doc/man/nvme_media_unit_config_desc.2
doc/man/nvme_media_unit_stat_desc.2
doc/man/nvme_media_unit_stat_log.2
doc/man/nvme_metadata_element_desc.2
doc/man/nvme_mi_admin_format_nvm.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_fw_commit.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_fw_download.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_features_data.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log.2
doc/man/nvme_mi_admin_get_log_ana.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_ana_groups.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_boot_partition.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_changed_ns_list.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_cmd_effects.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_create_telemetry_host.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_device_self_test.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_discovery.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_endurance_group.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_endurance_grp_evt.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_error.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_fid_supported_effects.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_fw_slot.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_lba_status.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_media_unit_stat.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_mi_cmd_supported_effects.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_persistent_event.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_predictable_lat_event.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_predictable_lat_nvmset.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_reservation.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_sanitize.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_simple.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_smart.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_support_cap_config_list.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_supported_log_pages.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_telemetry_ctrl.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_telemetry_host.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_log_zns_changed_zones.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_get_nsid_log.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_identify.2
doc/man/nvme_mi_admin_identify_active_ns_list.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_identify_allocated_ns.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_identify_allocated_ns_list.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_identify_cns_nsid.2
doc/man/nvme_mi_admin_identify_ctrl.2
doc/man/nvme_mi_admin_identify_ctrl_list.2
doc/man/nvme_mi_admin_identify_ns.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_identify_ns_descs.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_identify_nsid_ctrl_list.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_identify_partial.2
doc/man/nvme_mi_admin_identify_primary_ctrl.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_identify_secondary_ctrl_list.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_ns_attach.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_ns_attach_ctrls.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_ns_detach_ctrls.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_req_hdr.2
doc/man/nvme_mi_admin_resp_hdr.2
doc/man/nvme_mi_admin_sanitize_nvm.2 [new file with mode: 0644]
doc/man/nvme_mi_admin_security_recv.2
doc/man/nvme_mi_admin_security_send.2
doc/man/nvme_mi_admin_xfer.2
doc/man/nvme_mi_ccs.2
doc/man/nvme_mi_close.2
doc/man/nvme_mi_close_ctrl.2
doc/man/nvme_mi_cmd_supported_effects.2
doc/man/nvme_mi_cmd_supported_effects_log.2
doc/man/nvme_mi_config_id.2
doc/man/nvme_mi_config_smbus_freq.2
doc/man/nvme_mi_create_root.2
doc/man/nvme_mi_csts.2
doc/man/nvme_mi_ctrl_health_status.2
doc/man/nvme_mi_cwarn.2
doc/man/nvme_mi_dtyp.2
doc/man/nvme_mi_elem.2
doc/man/nvme_mi_free_root.2
doc/man/nvme_mi_init_ctrl.2
doc/man/nvme_mi_message_type.2
doc/man/nvme_mi_mi_opcode.2
doc/man/nvme_mi_mi_read_mi_data_ctrl.2
doc/man/nvme_mi_mi_read_mi_data_ctrl_list.2
doc/man/nvme_mi_mi_read_mi_data_port.2
doc/man/nvme_mi_mi_read_mi_data_subsys.2
doc/man/nvme_mi_mi_req_hdr.2
doc/man/nvme_mi_mi_resp_hdr.2
doc/man/nvme_mi_mi_subsystem_health_status_poll.2
doc/man/nvme_mi_msg_hdr.2
doc/man/nvme_mi_msg_resp.2
doc/man/nvme_mi_nvm_ss_health_status.2
doc/man/nvme_mi_open_mctp.2
doc/man/nvme_mi_osc.2
doc/man/nvme_mi_port_pcie.2
doc/man/nvme_mi_port_smb.2
doc/man/nvme_mi_read_ctrl_info.2
doc/man/nvme_mi_read_nvm_ss_info.2
doc/man/nvme_mi_read_port_info.2
doc/man/nvme_mi_read_sc_list.2
doc/man/nvme_mi_resp_status.2
doc/man/nvme_mi_status_to_string.2 [new file with mode: 0644]
doc/man/nvme_mi_vpd_hdr.2
doc/man/nvme_mi_vpd_mr_common.2
doc/man/nvme_mi_vpd_mra.2
doc/man/nvme_mi_vpd_ppmra.2
doc/man/nvme_mi_vpd_telem.2
doc/man/nvme_mi_vpd_tra.2
doc/man/nvme_namespace_attach_ctrls.2
doc/man/nvme_namespace_detach_ctrls.2
doc/man/nvme_namespace_filter.2
doc/man/nvme_namespace_first_path.2
doc/man/nvme_namespace_for_each_path.2
doc/man/nvme_namespace_for_each_path_safe.2
doc/man/nvme_namespace_next_path.2
doc/man/nvme_nd_ns_fpi.2
doc/man/nvme_next_host.2
doc/man/nvme_next_subsystem.2
doc/man/nvme_ns_attach.2
doc/man/nvme_ns_attach_ctrls.2
doc/man/nvme_ns_attach_sel.2
doc/man/nvme_ns_compare.2
doc/man/nvme_ns_detach_ctrls.2
doc/man/nvme_ns_flush.2
doc/man/nvme_ns_get_csi.2
doc/man/nvme_ns_get_ctrl.2
doc/man/nvme_ns_get_eui64.2 [new file with mode: 0644]
doc/man/nvme_ns_get_fd.2
doc/man/nvme_ns_get_firmware.2
doc/man/nvme_ns_get_generic_name.2
doc/man/nvme_ns_get_lba_count.2
doc/man/nvme_ns_get_lba_size.2
doc/man/nvme_ns_get_lba_util.2
doc/man/nvme_ns_get_meta_size.2
doc/man/nvme_ns_get_model.2
doc/man/nvme_ns_get_name.2
doc/man/nvme_ns_get_nguid.2
doc/man/nvme_ns_get_nsid.2
doc/man/nvme_ns_get_serial.2
doc/man/nvme_ns_get_subsystem.2
doc/man/nvme_ns_get_sysfs_dir.2
doc/man/nvme_ns_get_uuid.2
doc/man/nvme_ns_id_desc.2
doc/man/nvme_ns_id_desc_nidt.2
doc/man/nvme_ns_identify.2
doc/man/nvme_ns_identify_descs.2
doc/man/nvme_ns_list.2
doc/man/nvme_ns_metadata_type.2
doc/man/nvme_ns_mgmt.2
doc/man/nvme_ns_mgmt_create.2
doc/man/nvme_ns_mgmt_delete.2
doc/man/nvme_ns_mgmt_sel.2
doc/man/nvme_ns_read.2
doc/man/nvme_ns_rescan.2
doc/man/nvme_ns_verify.2
doc/man/nvme_ns_write.2
doc/man/nvme_ns_write_protect_cfg.2
doc/man/nvme_ns_write_uncorrectable.2
doc/man/nvme_ns_write_zeros.2
doc/man/nvme_nss_hw_err_event.2
doc/man/nvme_nvm_id_ns.2
doc/man/nvme_nvm_id_ns_elbaf.2
doc/man/nvme_nvm_identify_ctrl.2
doc/man/nvme_nvmeset_pl_status.2
doc/man/nvme_nvmset_attr.2
doc/man/nvme_nvmset_pl_events.2
doc/man/nvme_nvmset_predictable_lat_log.2
doc/man/nvme_open.2
doc/man/nvme_passthru_cmd.2
doc/man/nvme_passthru_cmd64.2 [new file with mode: 0644]
doc/man/nvme_path_get_ana_state.2
doc/man/nvme_path_get_ctrl.2
doc/man/nvme_path_get_name.2
doc/man/nvme_path_get_ns.2
doc/man/nvme_path_get_sysfs_dir.2
doc/man/nvme_paths_filter.2
doc/man/nvme_persistent_event_entry.2
doc/man/nvme_persistent_event_log.2
doc/man/nvme_persistent_event_types.2
doc/man/nvme_pevent_log_action.2
doc/man/nvme_plm_config.2
doc/man/nvme_pmr_size.2
doc/man/nvme_pmr_throughput.2
doc/man/nvme_power_on_reset_info_list.2
doc/man/nvme_primary_ctrl_cap.2
doc/man/nvme_psd_flags.2
doc/man/nvme_psd_power_scale.2
doc/man/nvme_psd_ps.2
doc/man/nvme_psd_workload.2
doc/man/nvme_read.2
doc/man/nvme_read_config.2
doc/man/nvme_refresh_topology.2
doc/man/nvme_register_offsets.2
doc/man/nvme_registered_ctrl.2
doc/man/nvme_registered_ctrl_ext.2
doc/man/nvme_rescan_ctrl.2
doc/man/nvme_resv_acquire.2
doc/man/nvme_resv_cptpl.2
doc/man/nvme_resv_notification_log.2
doc/man/nvme_resv_notify_rnlpt.2
doc/man/nvme_resv_racqa.2
doc/man/nvme_resv_register.2
doc/man/nvme_resv_release.2
doc/man/nvme_resv_report.2
doc/man/nvme_resv_rrega.2
doc/man/nvme_resv_rrela.2
doc/man/nvme_resv_rtype.2
doc/man/nvme_resv_status.2
doc/man/nvme_sanitize_compln_event.2
doc/man/nvme_sanitize_log_page.2
doc/man/nvme_sanitize_nvm.2
doc/man/nvme_sanitize_sanact.2
doc/man/nvme_sanitize_sstat.2
doc/man/nvme_sanitize_start_event.2
doc/man/nvme_scan.2
doc/man/nvme_scan_ctrl.2
doc/man/nvme_scan_ctrl_namespace_paths.2
doc/man/nvme_scan_ctrl_namespaces.2
doc/man/nvme_scan_ctrls.2
doc/man/nvme_scan_namespace.2
doc/man/nvme_scan_subsystem_namespaces.2
doc/man/nvme_scan_subsystems.2
doc/man/nvme_scan_topology.2
doc/man/nvme_secondary_ctrl.2
doc/man/nvme_secondary_ctrl_list.2
doc/man/nvme_security_receive.2
doc/man/nvme_security_send.2
doc/man/nvme_self_test_log.2
doc/man/nvme_set_feature_event.2
doc/man/nvme_set_features.2
doc/man/nvme_set_features_arbitration.2
doc/man/nvme_set_features_async_event.2
doc/man/nvme_set_features_auto_pst.2
doc/man/nvme_set_features_data.2
doc/man/nvme_set_features_endurance_evt_cfg.2
doc/man/nvme_set_features_err_recovery.2
doc/man/nvme_set_features_hctm.2
doc/man/nvme_set_features_host_behavior.2
doc/man/nvme_set_features_host_id.2
doc/man/nvme_set_features_irq_coalesce.2
doc/man/nvme_set_features_irq_config.2
doc/man/nvme_set_features_lba_range.2
doc/man/nvme_set_features_lba_sts_interval.2
doc/man/nvme_set_features_nopsc.2
doc/man/nvme_set_features_plm_config.2
doc/man/nvme_set_features_plm_window.2
doc/man/nvme_set_features_power_mgmt.2
doc/man/nvme_set_features_resv_mask.2
doc/man/nvme_set_features_resv_persist.2
doc/man/nvme_set_features_rrl.2
doc/man/nvme_set_features_sanitize.2
doc/man/nvme_set_features_simple.2
doc/man/nvme_set_features_sw_progress.2
doc/man/nvme_set_features_temp_thresh.2
doc/man/nvme_set_features_timestamp.2
doc/man/nvme_set_features_volatile_wc.2
doc/man/nvme_set_features_write_atomic.2
doc/man/nvme_set_features_write_protect.2
doc/man/nvme_set_property.2
doc/man/nvme_smart_crit.2
doc/man/nvme_smart_egcw.2
doc/man/nvme_smart_log.2
doc/man/nvme_st_code.2
doc/man/nvme_st_curr_op.2
doc/man/nvme_st_result.2
doc/man/nvme_st_valid_diag_info.2
doc/man/nvme_status_code.2
doc/man/nvme_status_code_type.2
doc/man/nvme_status_equals.2 [new file with mode: 0644]
doc/man/nvme_status_field.2
doc/man/nvme_status_get_type.2 [new file with mode: 0644]
doc/man/nvme_status_get_value.2 [new file with mode: 0644]
doc/man/nvme_status_result.2
doc/man/nvme_status_to_errno.2
doc/man/nvme_status_to_string.2
doc/man/nvme_status_type.2 [new file with mode: 0644]
doc/man/nvme_streams_directive_params.2
doc/man/nvme_streams_directive_status.2
doc/man/nvme_submit_admin_passthru.2
doc/man/nvme_submit_admin_passthru64.2 [new file with mode: 0644]
doc/man/nvme_submit_io_passthru.2
doc/man/nvme_submit_io_passthru64.2 [new file with mode: 0644]
doc/man/nvme_subsys_filter.2
doc/man/nvme_subsys_type.2
doc/man/nvme_subsystem_first_ctrl.2
doc/man/nvme_subsystem_first_ns.2
doc/man/nvme_subsystem_for_each_ctrl.2
doc/man/nvme_subsystem_for_each_ctrl_safe.2
doc/man/nvme_subsystem_for_each_ns.2
doc/man/nvme_subsystem_for_each_ns_safe.2
doc/man/nvme_subsystem_get_host.2
doc/man/nvme_subsystem_get_name.2
doc/man/nvme_subsystem_get_nqn.2
doc/man/nvme_subsystem_get_sysfs_dir.2
doc/man/nvme_subsystem_get_type.2
doc/man/nvme_subsystem_lookup_namespace.2
doc/man/nvme_subsystem_next_ctrl.2
doc/man/nvme_subsystem_next_ns.2
doc/man/nvme_subsystem_reset.2
doc/man/nvme_supported_cap_config_list_log.2
doc/man/nvme_supported_log_pages.2
doc/man/nvme_telemetry_da.2
doc/man/nvme_telemetry_log.2
doc/man/nvme_thermal_exc_event.2
doc/man/nvme_time_stamp_change_event.2
doc/man/nvme_timestamp.2
doc/man/nvme_unlink_ctrl.2
doc/man/nvme_update_config.2
doc/man/nvme_uring_cmd.2
doc/man/nvme_verify.2
doc/man/nvme_version.2
doc/man/nvme_virt_mgmt_act.2
doc/man/nvme_virt_mgmt_rt.2
doc/man/nvme_virtual_mgmt.2
doc/man/nvme_write.2
doc/man/nvme_write_uncorrectable.2
doc/man/nvme_write_zeros.2
doc/man/nvme_zns_append.2
doc/man/nvme_zns_changed_zone_log.2
doc/man/nvme_zns_desc.2
doc/man/nvme_zns_id_ctrl.2
doc/man/nvme_zns_id_ns.2
doc/man/nvme_zns_identify_ctrl.2
doc/man/nvme_zns_identify_ns.2
doc/man/nvme_zns_lbafe.2
doc/man/nvme_zns_mgmt_recv.2
doc/man/nvme_zns_mgmt_send.2
doc/man/nvme_zns_recv_action.2
doc/man/nvme_zns_report_options.2
doc/man/nvme_zns_report_zones.2
doc/man/nvme_zns_send_action.2
doc/man/nvme_zns_za.2
doc/man/nvme_zns_zs.2
doc/man/nvme_zns_zt.2
doc/man/nvme_zone_report.2
doc/man/nvmf_add_ctrl.2
doc/man/nvmf_addr_family.2
doc/man/nvmf_adrfam_str.2
doc/man/nvmf_cms_str.2
doc/man/nvmf_connect_data.2
doc/man/nvmf_connect_disc_entry.2
doc/man/nvmf_default_config.2
doc/man/nvmf_dim_data.2
doc/man/nvmf_dim_entfmt.2
doc/man/nvmf_dim_etype.2
doc/man/nvmf_dim_tas.2
doc/man/nvmf_disc_eflags.2
doc/man/nvmf_disc_log_entry.2
doc/man/nvmf_discovery_log.2
doc/man/nvmf_eflags_str.2
doc/man/nvmf_exat_len.2
doc/man/nvmf_exattype.2
doc/man/nvmf_ext_attr.2
doc/man/nvmf_ext_die.2
doc/man/nvmf_get_discovery_log.2
doc/man/nvmf_get_discovery_wargs.2 [new file with mode: 0644]
doc/man/nvmf_hostid_from_file.2
doc/man/nvmf_hostnqn_from_file.2
doc/man/nvmf_hostnqn_generate.2
doc/man/nvmf_log_discovery_lid_support.2 [new file with mode: 0644]
doc/man/nvmf_log_discovery_lsp.2 [new file with mode: 0644]
doc/man/nvmf_prtype_str.2
doc/man/nvmf_qptype_str.2
doc/man/nvmf_rdma_cms.2
doc/man/nvmf_rdma_prtype.2
doc/man/nvmf_rdma_qptype.2
doc/man/nvmf_register_ctrl.2
doc/man/nvmf_sectype_str.2
doc/man/nvmf_subtype_str.2
doc/man/nvmf_tcp_sectype.2
doc/man/nvmf_treq.2
doc/man/nvmf_treq_str.2
doc/man/nvmf_trtype.2
doc/man/nvmf_trtype_str.2
doc/man/nvmf_update_config.2
doc/rst/fabrics.rst
doc/rst/mi.rst
doc/rst/tree.rst
doc/rst/types.rst
doc/rst/util.rst

index 686434effecd180973fb8e2666fd407a13fd969e..abfa57c9ed17d6bbc4c99a17b568f2ecaae16cf4 100644 (file)
@@ -12,7 +12,7 @@ copyright = '2020, Keith Busch'
 author = 'Keith Busch <kbusch@kernel.org>'
 master_doc = 'index'
 
-release = '1.1'
+release = '1.2'
 
 
 # -- General configuration ---------------------------------------------------
index ddb0e0838a988cc3a45e654e906df8ee9a3bc750..69fb60650858529f42f1c876046790b0bd4fea5e 100644 (file)
                    "description": "NVMe host ID",
                    "type": "string"
                },
-               "hostsymname": {
-                   "description": "NVMe host symbolic name",
-                   "type": "string"
-               },
                "dhchap_key": {
                    "description": "Host DH-HMAC-CHAP key",
                    "type": "string"
                },
+               "hostsymname": {
+                   "description": "NVMe host symbolic name",
+                   "type": "string"
+               },
                "required": [ "hostnqn" ],
                "subsystems": {
                    "description": "Array of NVMe subsystem properties",
index ebe4f1523635c4bae76ce8a52c501773a3ceaf2e..be7d1c344cd9dff1f90c61622329936e646fd305 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_admin_opcode" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_admin_opcode" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_admin_opcode \- Known NVMe admin opcodes
 .SH SYNOPSIS
index 0703e97abf767152627ae4ddccec57412d0d4f9c..acf2a63ef0f05a2bd5057bff742cc76e4412168d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_admin_passthru" 9 "nvme_admin_passthru" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_admin_passthru \- Submit an nvme passthrough command
 .SH SYNOPSIS
diff --git a/doc/man/nvme_admin_passthru64.2 b/doc/man/nvme_admin_passthru64.2
new file mode 100644 (file)
index 0000000..806251e
--- /dev/null
@@ -0,0 +1,71 @@
+.TH "nvme_admin_passthru64" 9 "nvme_admin_passthru64" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_admin_passthru64 \- Submit a 64-bit nvme passthrough command
+.SH SYNOPSIS
+.B "int" nvme_admin_passthru64
+.BI "(int fd "  ","
+.BI "__u8 opcode "  ","
+.BI "__u8 flags "  ","
+.BI "__u16 rsvd "  ","
+.BI "__u32 nsid "  ","
+.BI "__u32 cdw2 "  ","
+.BI "__u32 cdw3 "  ","
+.BI "__u32 cdw10 "  ","
+.BI "__u32 cdw11 "  ","
+.BI "__u32 cdw12 "  ","
+.BI "__u32 cdw13 "  ","
+.BI "__u32 cdw14 "  ","
+.BI "__u32 cdw15 "  ","
+.BI "__u32 data_len "  ","
+.BI "void *data "  ","
+.BI "__u32 metadata_len "  ","
+.BI "void *metadata "  ","
+.BI "__u32 timeout_ms "  ","
+.BI "__u64 *result "  ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "opcode" 12
+The nvme io command to send
+.IP "flags" 12
+NVMe command flags (not used)
+.IP "rsvd" 12
+Reserved for future use
+.IP "nsid" 12
+Namespace identifier
+.IP "cdw2" 12
+Command dword 2
+.IP "cdw3" 12
+Command dword 3
+.IP "cdw10" 12
+Command dword 10
+.IP "cdw11" 12
+Command dword 11
+.IP "cdw12" 12
+Command dword 12
+.IP "cdw13" 12
+Command dword 13
+.IP "cdw14" 12
+Command dword 14
+.IP "cdw15" 12
+Command dword 15
+.IP "data_len" 12
+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 transferred in this command
+.IP "metadata" 12
+Pointer to user address of the metadata buffer
+.IP "timeout_ms" 12
+How long the kernel waits for the command to complete
+.IP "result" 12
+Optional field to return the result from the CQE dword 0
+.SH "DESCRIPTION"
+Parameterized form of \fBnvme_submit_admin_passthru64\fP. This sets up and
+submits a \fIstruct nvme_passthru_cmd64\fP.
+
+Known values for \fIopcode\fP are defined in \fIenum nvme_admin_opcode\fP.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index 48166323d34e274a36aab1256c904b1a0a4a65af..4090339672f734a03d56bb1bff5121ce200e1230 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_css_nvm" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ae_info_css_nvm \- Asynchronous Event Information - I/O Command Specific Status
 .SH SYNOPSIS
index 5f5f55ffdc8b4dd5f1d59fc3e742d00f0a78dd78..4b8deeb274d73be1e3d354ed5860a8ae7186cfa6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ae_info_error" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_error" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ae_info_error \- Asynchronous Event Information - Error Status
 .SH SYNOPSIS
index c815d669e4302513c1413d7908a55ddc8e95a504..5ccb5ed28ee8b6571e9cea5c1053f0033c59767e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ae_info_notice" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_notice" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ae_info_notice \- Asynchronous Event Information - Notice
 .SH SYNOPSIS
index a828666e40583aa7e5bbdf2569c936586bd4c523..964a7bb27806d2e486af64176844a40b6727aa21 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ae_info_smart" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_info_smart" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ae_info_smart \- Asynchronous Event Information - SMART / Health Status
 .SH SYNOPSIS
index 8bbd0636e818a74bad492777a43df3c71701c700..478522e73f18f4dddb9ba706409d80833668505d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ae_type" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ae_type" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ae_type \- Asynchronous Event Type
 .SH SYNOPSIS
index ddc19e1c1eef9af5f90e60d3838dc7f22d2ac458..8e104f4ffccd9ee36ab42dca29270e1525af1ad0 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_aggregate_endurance_group_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_aggregate_endurance_group_event \- Endurance Group Event Aggregate
 .SH SYNOPSIS
index 39bc4e1e9bd612f10cc8a44f43ab9426ee322639..871cf1c6845a1534ca8289ab17c5ae81351a6b40 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_aggregate_predictable_lat_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_aggregate_predictable_lat_event \- Predictable Latency Event Aggregate Log Page
 .SH SYNOPSIS
index 1c93e28c65f8ec4ec12857b4a21793a98785894a..02056c55ab73fcbb386cd5de7b624d9c9c950bf8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_ana_group_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ana_group_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_ana_group_desc \- ANA Group Descriptor
 .SH SYNOPSIS
index ea60e03d6d3c022d82a52b83a1520d928657e6f2..1a09d3155e75602fa1b5e25a5618f134a7360803 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_ana_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ana_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_ana_log \- Asymmetric Namespace Access Log
 .SH SYNOPSIS
index fbe76cff9fc55d0c544b25e322907e20cee72c36..a177adeae0711e3c4cfdf82a8cd92674bd426bcc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ana_state" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ana_state" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ana_state \- ANA Group Descriptor - Asymmetric Namespace Access State
 .SH SYNOPSIS
index 1472885db6fe5a83da07f9039ccab6670464411e..13b2077ae3c7759e6b680f82efcb5c6137f7d5ec 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_apst_entry" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_apst_entry" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_apst_entry \- Autonomous Power State Transition
 .SH SYNOPSIS
index e64b3e0324255fba8a0a599774fa6bb9e7ce2b59..0005b9959128f392ed3b10b33aaa2451e9eb3504 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_boot_partition" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_boot_partition" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_boot_partition \- Boot Partition Log
 .SH SYNOPSIS
index eb4ee6c561a9fae70cabea3ed4fa8b86c9adbb32..f3bd068cc4ef6994df5b1f8ee02d0d7d166d2b5d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_capacity_config_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_capacity_config_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_capacity_config_desc \- Capacity Configuration structure definitions
 .SH SYNOPSIS
index 2345ca0b27f3e377726ff8207d925e5b0e8f4093..8dba4a1b47310d1f11fe07e5bf31dd6b3d49a3aa 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_capacity_mgmt" 9 "nvme_capacity_mgmt" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_capacity_mgmt \- Capacity management command
 .SH SYNOPSIS
index 5f437c27e54ea2a83422ede7b6ba72f415596ffe..78920834a16caba719250822fd3e6a1ab364d73a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_change_ns_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_change_ns_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_change_ns_event \- Change Namespace Event Data
 .SH SYNOPSIS
index 5e58ce52d1173721bd995641b98ee0feb80df7a8..3948070c2520cb95ba30f073b87fe9aa3b99c31d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_channel_config_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_channel_config_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_channel_config_desc \- Channel Configuration Descriptor
 .SH SYNOPSIS
index 0ed5ed03fad8d91f7e37149a0f274ea9efee7b66..2166cba901893d25191b2774335306611a04f2ac 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_cmb_size" 9 "nvme_cmb_size" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_cmb_size" 9 "nvme_cmb_size" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_cmb_size \- Calculate size of the controller memory buffer
 .SH SYNOPSIS
index efd3c88ffdbd3d121528d2610e64cf058659bda6..7600ea37b477ff0264b5f4e0e894d7de600b8a71 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_cmd_effects" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_effects" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_cmd_effects \- Commands Supported and Effects
 .SH SYNOPSIS
index 669e86e0ddd6f995b7e5dfdc823fc88470920456..83e0a85f856b28c2b3d6a1fc3baa03d6a4f9c022 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_cmd_effects_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_cmd_effects_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_cmd_effects_log \- Commands Supported and Effects Log
 .SH SYNOPSIS
index aeaa72c959f20812b59433543e718b9e690d1039..d1cb0eb9fa4e87e76943d3f9ff9f80b0498c298f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_cmd_format_mset" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_format_mset" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_cmd_format_mset \- Format NVM - Metadata Settings
 .SH SYNOPSIS
index f77640a90b3a9a886521d0dc2a5165b0332eb1bb..87ca2f4d996acd5cdcc7444eb12f23f4d85523d2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_cmd_format_pi" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_format_pi" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_cmd_format_pi \- Format NVM - Protection Information
 .SH SYNOPSIS
index 388e6d152874ce07621e4df4727298310c4bc4a7..d21373f2411646d5f6faf8699085243ed696b8c6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_cmd_format_pil" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_format_pil" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_cmd_format_pil \- Format NVM - Protection Information Location
 .SH SYNOPSIS
index d0acccb0e5b5d495f05c2dff1bfdd0282e7e8b2b..257c7a5fe2272b0d53e5e7c76a88c3598063fabc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_cmd_format_ses" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_format_ses" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_cmd_format_ses \- Format NVM - Secure Erase Settings
 .SH SYNOPSIS
index be8aad40ea00ad959e707b916c3509dcf5e6298c..31ee57c2205a5bb615a363b44ed7237bb41e874b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_get_log_lid" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_cmd_get_log_lid \- Get Log Page -Log Page Identifiers
 .SH SYNOPSIS
index 436a5f00e73fbae469c14b1de452b860b17f38fa..7ba3d49b6152bcdc71875adec9439cf347beb1f5 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_cmd_get_log_telemetry_host_lsp" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_cmd_get_log_telemetry_host_lsp \- Telemetry Host-Initiated log specific field
 .SH SYNOPSIS
index 7d6d7d28f9eead99723674a7a99fd5d4a706b94e..961d5847f0163cf54efbeb6a3f5084091984c0a0 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_compare" 9 "nvme_compare" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_compare" 9 "nvme_compare" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_compare \- Submit an nvme user compare command
 .SH SYNOPSIS
index 7b41b4cb95a1a6fb990a8be2f0ba6678aca2cdb7..0b5e4bc97241c48c956c67af23f3353f63b76c8c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_connect_err" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_connect_err" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_connect_err \- nvme connect error codes
 .SH SYNOPSIS
index 7f1773c7911d1f4958c8d97290491a350f355936..a79031c8006924fc01ecbe3a55ee00b4e6bd256c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_constants" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_constants" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_constants \- A place to stash various constant nvme values
 .SH SYNOPSIS
index eb363e19385a24fb5f6beb2b7cb0c85117600be2..71489d21d24cdaf5e431b029c55050c036a50ece 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_copy" 9 "nvme_copy" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_copy" 9 "nvme_copy" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_copy \- Copy command
 .SH SYNOPSIS
index 9975b1ba798652d5da0902162d90c66cfe12c734..fb82d8d73d25bdae1001e6107156af2fda1c8068 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_copy_range" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_copy_range" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_copy_range \- Copy - Source Range Entries Descriptor Format
 .SH SYNOPSIS
diff --git a/doc/man/nvme_copy_range_f1.2 b/doc/man/nvme_copy_range_f1.2
new file mode 100644 (file)
index 0000000..f83ef09
--- /dev/null
@@ -0,0 +1,40 @@
+.TH "libnvme" 9 "struct nvme_copy_range_f1" "October 2022" "API Manual" LINUX
+.SH NAME
+struct nvme_copy_range_f1 \- Copy - Source Range Entries Descriptor Format 1h
+.SH SYNOPSIS
+struct nvme_copy_range_f1 {
+.br
+.BI "    __u8 rsvd0[8];"
+.br
+.BI "    __le64 slba;"
+.br
+.BI "    __le16 nlb;"
+.br
+.BI "    __u8 rsvd18[8];"
+.br
+.BI "    __u8 elbt[10];"
+.br
+.BI "    __le16 elbatm;"
+.br
+.BI "    __le16 elbat;"
+.br
+.BI "
+};
+.br
+
+.SH Members
+.IP "rsvd0" 12
+Reserved
+.IP "slba" 12
+Starting LBA
+.IP "nlb" 12
+Number of Logical Blocks
+.IP "rsvd18" 12
+Reserved
+.IP "elbt" 12
+Expected Initial Logical Block Reference Tag /
+Expected Logical Block Storage Tag
+.IP "elbatm" 12
+Expected Logical Block Application Tag Mask
+.IP "elbat" 12
+Expected Logical Block Application Tag
index 6b0053758306b31c9db4fc983a8013082279864a..325cb84eddc63e96429fca36633748cdc8dabf00 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_create_ctrl" 9 "nvme_create_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_create_ctrl \- Allocate an unconnected NVMe controller
 .SH SYNOPSIS
index dfe029dbc868eda1d1bbdb7531f66046f735da8a..924d7e29c550eebefb892fdb3713e6cf0fbad0f8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_create_root" 9 "nvme_create_root" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_create_root" 9 "nvme_create_root" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_create_root \- Initialize root object
 .SH SYNOPSIS
index 2ee3cd1cf6053cc9c01743a24e85c23d38179c11..c2496dc177b45f4374543298317e7f4319bec35b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_csi" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_csi" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_csi \- Defined command set indicators
 .SH SYNOPSIS
index ae64a2867aeeeb77c9b8c294937604404ee96d3f..8e8e4dfdd64a9d9e517cf0bed66e39d829ae9cfe 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_first_ns" 9 "nvme_ctrl_first_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_first_ns \- Start namespace iterator
 .SH SYNOPSIS
index 6945c3d9c9a4d7f98ba743b5fe1bd4e255fcc112..0247898df9436e0692644a0ce8027bc78b4e33f1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_first_path" 9 "nvme_ctrl_first_path" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_first_path \- Start path iterator
 .SH SYNOPSIS
index 331002576d257ed87c5505752fa0085c920f9285..d08adeb24e2de422705b50b508c4480e55c0f2ac 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_for_each_ns" 9 "nvme_ctrl_for_each_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_for_each_ns \- Traverse namespaces
 .SH SYNOPSIS
index 7ff6fc3866e43282095d970856864a42dae54625..87862b0db16d9a28921e9b22e582e331fe91d9e5 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_for_each_ns_safe" 9 "nvme_ctrl_for_each_ns_safe" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_for_each_ns_safe \- Traverse namespaces
 .SH SYNOPSIS
index 3a2289cedf947d3cf8dde743ba09a0a8589b1cfb..6d6d33f4728f8665377378ac9953b3f70b4cc3e7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_for_each_path" 9 "nvme_ctrl_for_each_path" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_for_each_path \- Traverse paths
 .SH SYNOPSIS
index 8e3dccd812f1efc90b65fc3e45d5f3abdf43c202..b2f8be4bc898b272e221c08f19312fe28f3a5284 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_for_each_path_safe" 9 "nvme_ctrl_for_each_path_safe" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_for_each_path_safe \- Traverse paths
 .SH SYNOPSIS
index 7d3536cc7f6af9e5c86e589c0f4e5b60952187c7..f9686c182807dd6272e04e4407ccb27368423701 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_address" 9 "nvme_ctrl_get_address" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_address \- Address string of a controller
 .SH SYNOPSIS
index 779ccc8bdeb487f22de62cfd8fbe0925a8a7b2e3..47269e528705036b989d2c4ca5173c5ca5aaa037 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_config" 9 "nvme_ctrl_get_config" "October 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_host_key.2 b/doc/man/nvme_ctrl_get_dhchap_host_key.2
new file mode 100644 (file)
index 0000000..174aa97
--- /dev/null
@@ -0,0 +1,11 @@
+.TH "nvme_ctrl_get_dhchap_host_key" 9 "nvme_ctrl_get_dhchap_host_key" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_ctrl_get_dhchap_host_key \- Return host key
+.SH SYNOPSIS
+.B "const char *" nvme_ctrl_get_dhchap_host_key
+.BI "(nvme_ctrl_t c "  ");"
+.SH ARGUMENTS
+.IP "c" 12
+Controller to be checked
+.SH "RETURN"
+DH-HMAC-CHAP host key or NULL if not set
index 3187eeca9b99c85e6f562fd023f535846aed80cf..a3efd363a045df15c7c2cf4014452714eb14104b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_dhchap_key" 9 "nvme_ctrl_get_dhchap_key" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_dhchap_key \- Return controller key
 .SH SYNOPSIS
index b41ebbcfb11e93854e77355814cc19b6daf96f7a..daf746b9a09e29fef4d0b9bb7447ba3e0d059317 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_fd" 9 "nvme_ctrl_get_fd" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_fd \- Get associated file descriptor
 .SH SYNOPSIS
index 0ceadc6bd80976ca8a9f201961537d6506eaec7d..3e3766cc7107d4809922588819ba8d258a026251 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_firmware" 9 "nvme_ctrl_get_firmware" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_firmware \- Firmware string of a controller
 .SH SYNOPSIS
index 980ec60a0ee9da96251838ff75995662c1352b48..2e98010c7c9eee2f1e1abdedd560b5b36c6481d4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_host_iface" 9 "nvme_ctrl_get_host_iface" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_host_iface \- Host interface name of a controller
 .SH SYNOPSIS
index 8a8967b64178830f2a092a8b65e772e0713f1deb..61022697529055ae769c5d38f96be3ba03980940 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_host_traddr" 9 "nvme_ctrl_get_host_traddr" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_host_traddr \- Host transport address of a controller
 .SH SYNOPSIS
index 50476c9cb22dd23d850c1e20439d2f1a485a8a7b..3471eb9b3eab84540f9cbfdea1fde0c9c1bb5619 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_model" 9 "nvme_ctrl_get_model" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_model \- Model of a controller
 .SH SYNOPSIS
index 09be7161a9d14910b80981f77f759ac07b71f589..0c9c5bd507584c23df278a619d13421e83ccd816 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_name" 9 "nvme_ctrl_get_name" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_name \- sysfs name of a controller
 .SH SYNOPSIS
index 6b8bc081e3b98f90a1b6694a930c39d02c1a2531..6be8e992ab61e922698c16a7b24cd23f4ad4ad72 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_numa_node" 9 "nvme_ctrl_get_numa_node" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_numa_node \- NUMA node of a controller
 .SH SYNOPSIS
index f2fc809de3a6faba78228cea922efcd9eac23daa..8852d849fc0e0e42fdb1fa44bf76134dd4198af9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_queue_count" 9 "nvme_ctrl_get_queue_count" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_queue_count \- Queue count of a controller
 .SH SYNOPSIS
index c7af10661897d6a82c1b7a4397358c38bf97dfe4..0af26f4f61672511557b707c15d59d919b7f0c55 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_serial" 9 "nvme_ctrl_get_serial" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_serial \- Serial number of a controller
 .SH SYNOPSIS
index ef0f40720dc95e4c1be513e6c3be21f38854f53d..2ff350d37044bc370da94dd181b2ff6ffd297566 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_sqsize" 9 "nvme_ctrl_get_sqsize" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_sqsize \- SQ size of a controller
 .SH SYNOPSIS
index 80b38186b9cb498604b35528063de13b63a8bb5b..d7877585b2f4b9898d056f72dac3129cc939c8bc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_state" 9 "nvme_ctrl_get_state" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_state \- Running state of an controller
 .SH SYNOPSIS
index 9c3f5ee1c88c3b9380faeef636b139dc18e3a28f..3b14394bfa31597fef512a30f0ae5e3395009b56 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_subsysnqn" 9 "nvme_ctrl_get_subsysnqn" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_subsysnqn \- Subsystem NQN of a controller
 .SH SYNOPSIS
index 31f2869ab645f3bc7f75b999f39f6a7a4a495986..0c0f7ca67c164c4cdb163eb22ab4b69996b9ec37 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_subsystem" 9 "nvme_ctrl_get_subsystem" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_subsystem \- Parent subsystem of a controller
 .SH SYNOPSIS
index 12b5eb71251cb1e74b51d5b2de30b87283ec2db8..247aada08633a42811a225b3eb503bca76fda242 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_sysfs_dir" 9 "nvme_ctrl_get_sysfs_dir" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_sysfs_dir \- sysfs directory of a controller
 .SH SYNOPSIS
index 7dca45059c557d2deb374fa2c4523b37656076a1..ce9c9616337338a4134d0a11fba0a0befa9d06a4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_traddr" 9 "nvme_ctrl_get_traddr" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_traddr \- Transport address of a controller
 .SH SYNOPSIS
index 7134db9cda8392981e4ca99401ad8b70cae3ff11..d0b2fb60422408bfb4aac6fc22649952b9d0e2df 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_transport" 9 "nvme_ctrl_get_transport" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_transport \- Transport type of a controller
 .SH SYNOPSIS
index f684a88afd8e38ffb0e582777dedbcd7325aab32..b1e6b5a6f9501ae7b235e75dd8ed8b554129ef43 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_get_trsvcid" 9 "nvme_ctrl_get_trsvcid" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_get_trsvcid \- Transport service identifier of a controller
 .SH SYNOPSIS
index 735d509c4d7c025b054cef3ee0ad28d147054027..ce17f5c7b8c0d281dd0b053efcc85e13e166ccb8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_identify" 9 "nvme_ctrl_identify" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_identify \- Issues an 'identify controller' command
 .SH SYNOPSIS
index 1bfe472b70ad3e461056477e8f614a75eb0f4da7..d6dd6d5978863d6486da5e08dad8ea3108764618 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_is_discovered" 9 "nvme_ctrl_is_discovered" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_is_discovered \- Returns the value of the 'discovered' flag
 .SH SYNOPSIS
index 81da033b6cdbae320bfe02ec752964388704ff29..6ad4d00ae21943532c8e78aea8679d83fb4a24bc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_is_discovery_ctrl" 9 "nvme_ctrl_is_discovery_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_is_discovery_ctrl \- Check the 'discovery_ctrl' flag
 .SH SYNOPSIS
index a4e4aec23b1aef73e4fe29380c01840c34e4751a..37ca92c005e64965285578b61c1fce9e319c6362 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_is_persistent" 9 "nvme_ctrl_is_persistent" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_is_persistent \- Returns the value of the 'persistent' flag
 .SH SYNOPSIS
index 264775e1e3505b10a0028aa6a00d695cede1ad8f..dabdc0ceba4d91fbf48ae945b0947b619d29dd95 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_ctrl_list" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ctrl_list" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_ctrl_list \- Controller List
 .SH SYNOPSIS
index b7e36b6c94e1975fd7219139b5814b810b929f40..24caeeebb3350ec736817dbd3fbcd66a1be14a54 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ctrl_metadata_type" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ctrl_metadata_type \- Controller Metadata Element Types
 .SH SYNOPSIS
index 6a6459f924f84a5c10d87204c1a09755f084e088..7e98adde1526d5246ac911993ea18027eab86a15 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_next_ns" 9 "nvme_ctrl_next_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_next_ns \- Next namespace iterator
 .SH SYNOPSIS
index 2b763354134f40402e74c05714104400bef8cfad..208196518bb22eb37f4ea9b2c6680cd8e8d5ebdc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_next_path" 9 "nvme_ctrl_next_path" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_next_path \- Next path iterator
 .SH SYNOPSIS
index 0d8ede1c30de7a6eba798de1bfe42825b8d4c2f0..55f084ac694e6651ce3c03e0a045803427a5061f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_reset" 9 "nvme_ctrl_reset" "October 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_host_key.2 b/doc/man/nvme_ctrl_set_dhchap_host_key.2
new file mode 100644 (file)
index 0000000..036c29e
--- /dev/null
@@ -0,0 +1,12 @@
+.TH "nvme_ctrl_set_dhchap_host_key" 9 "nvme_ctrl_set_dhchap_host_key" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_ctrl_set_dhchap_host_key \- Set host key
+.SH SYNOPSIS
+.B "void" nvme_ctrl_set_dhchap_host_key
+.BI "(nvme_ctrl_t c "  ","
+.BI "const char *key "  ");"
+.SH ARGUMENTS
+.IP "c" 12
+Host for which the key should be set
+.IP "key" 12
+DH-HMAC-CHAP Key to set or NULL to clear existing key
index 506de41b76fd6862abc727a505df3966cff80e3c..bcaaf868804113b2133500f3eff6c36e9bdbe3e4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_set_dhchap_key" 9 "nvme_ctrl_set_dhchap_key" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_set_dhchap_key \- Set controller key
 .SH SYNOPSIS
index 4e7bf4cbf79fca61fd6999e1c581a71314a93d53..0565135e81acbc9fa3f86a1fc53faa79e4f7044a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_set_discovered" 9 "nvme_ctrl_set_discovered" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_set_discovered \- Set the 'discovered' flag
 .SH SYNOPSIS
index d21c93ec636194d0115974edc5e8176bdb6120f8..a2c6200ba8acd88949caeeaf7111d154763cb572 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_set_discovery_ctrl" 9 "nvme_ctrl_set_discovery_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_set_discovery_ctrl \- Set the 'discovery_ctrl' flag
 .SH SYNOPSIS
index 5fee767849a68314525f1fc680e4dcc2be8cac20..d86e8d998e28663fa350185bf305f63562845f98 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrl_set_persistent" 9 "nvme_ctrl_set_persistent" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrl_set_persistent \- Set the 'persistent' flag
 .SH SYNOPSIS
index 70666bbf6f1946a4810cf644d43c0ddacf22c4d6..498f7245113af8721efc57a6ff18a5a14b8954de 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ctrls_filter" 9 "nvme_ctrls_filter" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ctrls_filter \- Filter for controllers
 .SH SYNOPSIS
diff --git a/doc/man/nvme_data_tfr.2 b/doc/man/nvme_data_tfr.2
new file mode 100644 (file)
index 0000000..bf0e99a
--- /dev/null
@@ -0,0 +1,30 @@
+.TH "libnvme" 9 "enum nvme_data_tfr" "October 2022" "API Manual" LINUX
+.SH NAME
+enum nvme_data_tfr \- Data transfer direction of the command
+.SH SYNOPSIS
+enum nvme_data_tfr {
+.br
+.BI "    NVME_DATA_TFR_NO_DATA_TFR"
+, 
+.br
+.br
+.BI "    NVME_DATA_TFR_HOST_TO_CTRL"
+, 
+.br
+.br
+.BI "    NVME_DATA_TFR_CTRL_TO_HOST"
+, 
+.br
+.br
+.BI "    NVME_DATA_TFR_BIDIRECTIONAL"
+
+};
+.SH Constants
+.IP "NVME_DATA_TFR_NO_DATA_TFR" 12
+No data transfer
+.IP "NVME_DATA_TFR_HOST_TO_CTRL" 12
+Host to controller
+.IP "NVME_DATA_TFR_CTRL_TO_HOST" 12
+Controller to host
+.IP "NVME_DATA_TFR_BIDIRECTIONAL" 12
+Bidirectional
index f112ab2969b650fd3c75abee763c9a6055b6fa8b..2ca5d981341f78b45cd8155a9f9868d672b4f05d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_default_host" 9 "nvme_default_host" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_default_host" 9 "nvme_default_host" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_default_host \- Initializes the default host
 .SH SYNOPSIS
index ac994a04fdcd868bd903f6e305f5023ef6cbed64..e366b9b8474f5b848d5c3e7fe654bf184779693f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_dev_self_test" 9 "nvme_dev_self_test" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_dev_self_test \- Start or abort a self test
 .SH SYNOPSIS
index dee81149c6f1c635b7da3acd89c66f34747f4eaa..8ee7b9c5f658bb8c6106029e79633c67835f12ab 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_directive_dtype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_directive_dtype" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_directive_dtype \- Directive Types
 .SH SYNOPSIS
index 4b00691bb682b59e21bf2697f22a709cd496c6d5..03c43abf96a099604fb779983588515c4fd59732 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_directive_receive_doper" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_directive_receive_doper" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_directive_receive_doper \- Directive Receive Directive Operation
 .SH SYNOPSIS
index b3aa7b08c0932cb001bdbefaac78eb575ab5c92c..1494ecd25afcb6c3c469f4c5b5fa12800de865f4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_directive_recv" 9 "nvme_directive_recv" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_directive_recv" 9 "nvme_directive_recv" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_directive_recv \- Receive directive specific data
 .SH SYNOPSIS
index 3f8e2f01f149dd2765bccdd4e8f8dc3eb00d42a9..828c5b6feeea0499d849ca05d2c2bf4913a0f723 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_directive_recv_identify_parameters" 9 "nvme_directive_recv_identify_parameters" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_directive_recv_identify_parameters" 9 "nvme_directive_recv_identify_parameters" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_directive_recv_identify_parameters \- Directive receive identifier parameters
 .SH SYNOPSIS
index 2e7304c6ba09cfad3a768796ba3a4a33f24a1ca2..131158566274761c2c7e0573d5ec1b7d4b250b73 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_directive_recv_stream_allocate" 9 "nvme_directive_recv_stream_allocate" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_directive_recv_stream_allocate" 9 "nvme_directive_recv_stream_allocate" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_directive_recv_stream_allocate \- Directive receive stream allocate
 .SH SYNOPSIS
index 6e5d77cdfc7bd25f7be265d59de3e2109f0afe25..179c4a6a4b07a5ae8e49228219530786f4c0ebc5 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_directive_recv_stream_parameters" 9 "nvme_directive_recv_stream_parameters" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_directive_recv_stream_parameters" 9 "nvme_directive_recv_stream_parameters" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_directive_recv_stream_parameters \- Directive receive stream parameters
 .SH SYNOPSIS
index 497bbeba90d6ec74f116fe5692bdac9a7ddbb744..68101c9081b31b2dc6706c1c5fa850adecf701de 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_directive_recv_stream_status" 9 "nvme_directive_recv_stream_status" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_directive_recv_stream_status" 9 "nvme_directive_recv_stream_status" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_directive_recv_stream_status \- Directive receive stream status
 .SH SYNOPSIS
index 9fad9ef81726d0506c6849b2c389afb85b2f9ad2..74469e33a0ce171a7b01b48ec20cd103e53112d8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_directive_send" 9 "nvme_directive_send" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_directive_send" 9 "nvme_directive_send" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_directive_send \- Send directive command
 .SH SYNOPSIS
index 48355e47f9f7f2032f23edcd60eab20e302c4d03..7e8bd7db2bae9abcda55ab68cff3e92f4e61f4c6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_directive_send_doper" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_directive_send_doper" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_directive_send_doper \- Directive Send Directive Operation
 .SH SYNOPSIS
index 3f6f46e3aae8c960be46f7c28c052ee421c3d7a4..9d4761183aaf000bc32640ea2ee5c0632923f60d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_directive_send_id_endir" 9 "nvme_directive_send_id_endir" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_directive_send_id_endir" 9 "nvme_directive_send_id_endir" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_directive_send_id_endir \- Directive Send Enable Directive
 .SH SYNOPSIS
index 83838efe66c5d8de613d3b1ab54b660080bffb3f..b4c3d08f2f3b2ff46db9d35858d796e95205855d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_directive_send_identify_endir" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_directive_send_identify_endir" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_directive_send_identify_endir \- Enable Directive
 .SH SYNOPSIS
index 09cfb418e6badb853356f9423c673c575c72a463..baa509e803beda61816fb172c8d549ef24da1b68 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_directive_send_stream_release_identifier" 9 "nvme_directive_send_stream_release_identifier" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_directive_send_stream_release_identifier" 9 "nvme_directive_send_stream_release_identifier" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_directive_send_stream_release_identifier \- Directive Send Stream release
 .SH SYNOPSIS
index 1ddfa74b19f1145917b6c7bcb15232b499d1c8e4..fbcb6090574e49d3dc2e5d1832877266218982a7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_directive_send_stream_release_resource" 9 "nvme_directive_send_stream_release_resource" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_directive_send_stream_release_resource" 9 "nvme_directive_send_stream_release_resource" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_directive_send_stream_release_resource \- Directive Send Stream release resources
 .SH SYNOPSIS
index f8ba3c1a82a8cffd6663a4ad8d0b9f1b4f9cab98..944dca7df034c2954b0e6c5d22361824dd83dc7c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_directive_types" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_directive_types" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_directive_types \- Directives Supported or Enabled
 .SH SYNOPSIS
index be383adae91738f3851ef0c85ca141d9c4959e54..7e7db9989155816dc3ed50c1f065c4ce4fc0bde1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_disconnect_ctrl" 9 "nvme_disconnect_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_disconnect_ctrl" 9 "nvme_disconnect_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_disconnect_ctrl \- Disconnect a controller
 .SH SYNOPSIS
index 2c9e37c40a02610c100820b47dfa8795cafc5b90..b567d21a855b341f0dc9a77539e9af7886654541 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_dsm" 9 "nvme_dsm" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_dsm" 9 "nvme_dsm" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_dsm \- Send an nvme data set management command
 .SH SYNOPSIS
index 8f326a10a815d41b35bce0b3b80284f12ed29858..1c42a949aee0d838e7322213c81482f005eaaf78 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_dsm_attributes" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_dsm_attributes" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_dsm_attributes \- Dataset Management attributes
 .SH SYNOPSIS
index 04bc88c3fceae98f491f848de35d812e96310456..8ff7b3c9c08b94bca2a6a97cf62807895ce0127d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_dsm_range" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_dsm_range" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_dsm_range \- Dataset Management - Range Definition
 .SH SYNOPSIS
index b22649caf8ec0ef384e148938507341dc0b52b9e..9654e640c67bac64b37db8cb4d4c3edb46fa137e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_dst_stc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_dst_stc" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_dst_stc \- Action taken by the Device Self-test command
 .SH SYNOPSIS
index 1403ca55fca468067972f6aaf1a1e1168914f4fb..400da1d5a6ea09f951e48d6d1022279d70c18899 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_dump_config" 9 "nvme_dump_config" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_dump_config" 9 "nvme_dump_config" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_dump_config \- Print the JSON configuration
 .SH SYNOPSIS
index 35c51e5d580356a12840fe1fcad63ca1963c3d72..52b5392b776bb67ffa2d96c22026ed94bcbc109f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_dump_tree" 9 "nvme_dump_tree" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_dump_tree" 9 "nvme_dump_tree" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_dump_tree \- Dump internal object tree
 .SH SYNOPSIS
index d5a4a8e7a601fec7b39fabcaebbeca6867de9a70..e60d99bba9bf42bd723af650e2303177ccb373dc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_eg_critical_warning_flags" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_eg_critical_warning_flags" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_eg_critical_warning_flags \- Endurance Group Information Log - Critical Warning
 .SH SYNOPSIS
index 7c52e69fe560402cd8b9b7f9b6b9c04ccc81dc5e..7ee2d834a199d3be5901749501d5f171d50ab2b3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_eg_event_aggregate_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_eg_event_aggregate_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_eg_event_aggregate_log \- Endurance Group Event Aggregate
 .SH SYNOPSIS
index d5142ea326ac89efc046125d24ddc62aafd72abf..d01687732cc6231df6d4d7820bb8b86add78d449 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_end_grp_chan_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_end_grp_chan_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_end_grp_chan_desc \- Endurance Group Channel Configuration Descriptor
 .SH SYNOPSIS
index 35039a97f373a042c4d48846cadcf1979ea0b2ab..947aada2af9f61894713e2161760089b1a525e22 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_end_grp_config_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_end_grp_config_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_end_grp_config_desc \- Endurance Group Configuration Descriptor
 .SH SYNOPSIS
index e9da1666f9f62cd80bc5941fef50c9ab959f11da..57dd1d8957b51edb9ccd29c53d750f0553c78e66 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_endurance_group_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_endurance_group_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_endurance_group_log \- Endurance Group Information Log
 .SH SYNOPSIS
index a0aaad599252963569a03da2d85bfaf693e4929a..71fb96afdb9306dc16d227444a139f40d27cf48d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_errno_to_string" 9 "nvme_errno_to_string" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_errno_to_string" 9 "nvme_errno_to_string" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_errno_to_string \- Returns string describing nvme connect failures
 .SH SYNOPSIS
index 8188d83984ebb983347a89d7e03e52afe23f0b77..80a1efaf2902aca248a5ff09e0a413a7a2a3dc3d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_error_log_page" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_error_log_page" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_error_log_page \- Error Information Log Entry (Log Identifier 01h)
 .SH SYNOPSIS
index 72b30214c6b833f37147d0221b1ad643cbb4fb3e..f0ff8f8e8b2a7d74489fade25b82469234b7bc77 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_fabrics_config" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fabrics_config" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_fabrics_config \- Defines all linux nvme fabrics initiator options
 .SH SYNOPSIS
index 90b5d46d1e1d671e11cc298ab10d85776db93f27..42b1c0c4748cfb7a64e4e5354c769dc15da5e363 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_fctype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fctype" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_fctype \- Fabrics Command Types
 .SH SYNOPSIS
index 86cb2f49567805ecb543220a9825e9d63b468dca..6b2e8b3f01aca3d80556218e79934aed9af518b6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_feat" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_feat" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_feat \- Features Access Shifts/Masks values
 .SH SYNOPSIS
index ef8989d89940344f71034e73db6f6b426d83a83d..48ec4c04e77182a300f655bf3c54d3a927c1f9df 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_feat_auto_pst" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_feat_auto_pst" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_feat_auto_pst \- Autonomous Power State Transition
 .SH SYNOPSIS
index 9949541f10389320380579d324de105e78461832..c4357caa89406577b629cc040ce2a80deb600836 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_feat_host_behavior" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_feat_host_behavior" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_feat_host_behavior \- Host Behavior Support - Data Structure
 .SH SYNOPSIS
index d7dc994ab7abd09aa5e404fa8f64b76a33219bdd..408cd2151c85bd31a3a67c95d2aba988bbc3da41 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_feat_nswpcfg_state" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_feat_nswpcfg_state" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_feat_nswpcfg_state \- Write Protection - Write Protection State
 .SH SYNOPSIS
index 43ffe975744f22927d19692b4a57c96a12d2c5aa..8b11e49f1c23b498bae55620b71bae8d866e739a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_feat_plm_window_select" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_feat_plm_window_select" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_feat_plm_window_select \- Predictable Latency Per NVM Set Log
 .SH SYNOPSIS
index d6ccf35be13a63199922f5e9fa440c5c6f2dc7f2..26c7b4fcbe091ba620a1d3b73ccce5ec1f5ae282 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_feat_resv_notify_flags" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_feat_resv_notify_flags" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_feat_resv_notify_flags \- Reservation Notification Configuration
 .SH SYNOPSIS
index 29046193384c7599753c3519d1c603adc1ac108f..872658f745f7623bf639bd8b9cee546b2bb288f7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_feat_tmpthresh_thsel" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_feat_tmpthresh_thsel" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_feat_tmpthresh_thsel \- Temperature Threshold - Threshold Type Select
 .SH SYNOPSIS
index 4bcea652b6459134405189294cbbf0eedcf93947..1651598414ea68a261d48c6334ce35e154c8308c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_features_async_event_config_flags" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_features_async_event_config_flags" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_features_async_event_config_flags \- Asynchronous Event Configuration configuration flags
 .SH SYNOPSIS
index b31f69f17da44ca5698f9c5ebce925622a1d7f25..c9c4981362d34a950b0c9103fcf89a276d70e93f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_features_id" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_features_id" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_features_id \- Features - Feature Identifiers
 .SH SYNOPSIS
index 4f8025799d09f9fc9e5fae68774b82d38347e94d..37e424ba809108bc9b8ae4e000031f3b518111df 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_fid_supported_effects" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fid_supported_effects" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_fid_supported_effects \- FID Supported and Effects Data Structure definitions
 .SH SYNOPSIS
index f73269f2faba8f1cd0f7b09751704e424460aad3..992e47e801338e39491d341a745b08ba7222c742 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_fid_supported_effects_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fid_supported_effects_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_fid_supported_effects_log \- Feature Identifiers Supported and Effects
 .SH SYNOPSIS
index f091cc11aa55f76d1f858a8f7c0c5cfd014dac67..6715665c5f99c680a1d02f69e70f36726e5947ae 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_firmware_slot" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_firmware_slot" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_firmware_slot \- Firmware Slot Information Log
 .SH SYNOPSIS
index 0f65bec7a0a1049dd934fc437a2c17e95c2371e7..b813604f70d69842ff89e8b0a995dee799956312 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_first_host" 9 "nvme_first_host" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_first_host" 9 "nvme_first_host" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_first_host \- Start host iterator
 .SH SYNOPSIS
index 62a6d54c4d574d497d027fd0e7c77217d8eac2aa..dc356e1a9dc1d5df64c801185eba6c1b0c8d5e12 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_first_subsystem" 9 "nvme_first_subsystem" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_first_subsystem" 9 "nvme_first_subsystem" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_first_subsystem \- Start subsystem iterator
 .SH SYNOPSIS
index 4202f41e95ddb935b21c69e9d55c9c74934b9a83..125874f50b271577a00a1638a855fde61c993fb8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_flush" 9 "nvme_flush" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_flush" 9 "nvme_flush" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_flush \- Send an nvme flush command
 .SH SYNOPSIS
index 03a3882b326c78d9e684c5345050e440052f65f6..c8db3778f929090a9cd00d62d09f173af4235a08 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_for_each_host" 9 "nvme_for_each_host" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_for_each_host" 9 "nvme_for_each_host" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_for_each_host \- Traverse host list
 .SH SYNOPSIS
index 8b61009b70707c7a09a9da463e0f9141b27a7de8..d95ce6fc17ab8494eee092dbcbfd02ceea1bb509 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_for_each_host_safe" 9 "nvme_for_each_host_safe" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_for_each_host_safe" 9 "nvme_for_each_host_safe" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_for_each_host_safe \- Traverse host list
 .SH SYNOPSIS
index 943819b40c8e0cd84ddb81a4c5fc7c2e1a5b3121..29e1a04a3c6b81d14c6c3813d4d323bf8f16bd63 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_for_each_subsystem" 9 "nvme_for_each_subsystem" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_for_each_subsystem" 9 "nvme_for_each_subsystem" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_for_each_subsystem \- Traverse subsystems
 .SH SYNOPSIS
index 5d54aef5791bbddda49318969bdf002ba29dbf45..9ce4e9299a3781688fb6fa3a582ef2a2c56f820e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_for_each_subsystem_safe" 9 "nvme_for_each_subsystem_safe" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_for_each_subsystem_safe" 9 "nvme_for_each_subsystem_safe" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_for_each_subsystem_safe \- Traverse subsystems
 .SH SYNOPSIS
index 6733f696f8b087909c1c2987946be907fb6232f8..698fe37a745116361f88fd52a0d6b833b6df4017 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_format_nvm" 9 "nvme_format_nvm" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_format_nvm" 9 "nvme_format_nvm" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_format_nvm \- Format nvme namespace(s)
 .SH SYNOPSIS
index 54b462f673863a4b08c99a0127a86e1f8222bc2a..967826e97f2cebcd6c6aed7e918ffb7083cfb1fd 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_format_nvm_compln_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_format_nvm_compln_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_format_nvm_compln_event \- Format NVM Completion Event Data
 .SH SYNOPSIS
index 0356ae8263115273ad56f7f0eaeb425997a57a89..681aa10ae8cf522fea21de3f99eb527e7c4fbeb4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_format_nvm_start_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_format_nvm_start_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_format_nvm_start_event \- Format NVM Start Event Data
 .SH SYNOPSIS
index 9a4f5a015c0de5c7a03faa210e0357b49622e09e..3d7af4a88826a51f3806e3f442144042da2080b4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_free_ctrl" 9 "nvme_free_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_free_ctrl" 9 "nvme_free_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_free_ctrl \- Free controller
 .SH SYNOPSIS
index 3738b317375a7b812a8367bec01fc8fdc09e59a1..f61d3c5f17135af3e22681afbedf53ebbe792c4c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_free_host" 9 "nvme_free_host" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_free_host" 9 "nvme_free_host" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_free_host \- Free nvme_host_t object
 .SH SYNOPSIS
index 84dcd16811069ab26127d5e4290e0b3d4788306c..dcf1325cd138b794ca9b2fc267518c824e321a0b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_free_ns" 9 "nvme_free_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_free_ns" 9 "nvme_free_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_free_ns \- Free a namespace object
 .SH SYNOPSIS
index d437768757a252c90da2906f0bf67e8872075739..dd2354ac85de9866c64458485b4e7f440b3b4b5f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_free_subsystem" 9 "nvme_free_subsystem" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_free_subsystem" 9 "nvme_free_subsystem" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_free_subsystem \- Free a subsystem
 .SH SYNOPSIS
index 3bfd3580151cd5596119406fa0956dd96f686d0d..c2a17dd2bed47be8ea12639b087ff5e89d56f3e0 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_free_tree" 9 "nvme_free_tree" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_free_tree" 9 "nvme_free_tree" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_free_tree \- Free root object
 .SH SYNOPSIS
index f377419d69fa1b69c358bba7ec56f461dd35d898..6228653c8ec745f6cf848d454fdfe2da5ab02d44 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_fw_commit" 9 "nvme_fw_commit" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_fw_commit" 9 "nvme_fw_commit" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_fw_commit \- Commit firmware using the specified action
 .SH SYNOPSIS
index adea8e6be9c7e8aa1038b0bdbff82c9bbf828b59..5c02ae9068daa3c64a947edaddeedf176044c7de 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_fw_commit_ca" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_fw_commit_ca" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_fw_commit_ca \- Firmware Commit - Commit Action
 .SH SYNOPSIS
index 76a06295f74e1561199d6d6677989488c3863283..6800b92b832d7767dd593fba841e8fdd9bcb0ac8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_fw_commit_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_fw_commit_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_fw_commit_event \- Firmware Commit Event Data
 .SH SYNOPSIS
index e889e7ab6e7395de9c6939ff005ae37c6b55e4a0..a6653188ef4735f0788efb88da99c71a7fdf3789 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_fw_download" 9 "nvme_fw_download" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_fw_download" 9 "nvme_fw_download" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_fw_download \- Download part or all of a firmware image to the controller
 .SH SYNOPSIS
index 51c545e0f7cf3c8020450d685e7c79fba5de37f6..c79022136cabec2442130bf3eea117b41c990b90 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_fw_download_seq" 9 "nvme_fw_download_seq" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_fw_download_seq" 9 "nvme_fw_download_seq" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_fw_download_seq \- Firmware download sequence
 .SH SYNOPSIS
index c4616ca13d005118c90b149cc10299a8d1474e3f..19531c9858591bdb2e6fe6e7f4f68cb40e6cc5e0 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_gen_dhchap_key" 9 "nvme_gen_dhchap_key" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_gen_dhchap_key" 9 "nvme_gen_dhchap_key" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_gen_dhchap_key \- DH-HMAC-CHAP key generation
 .SH SYNOPSIS
index a5856d56aebcc6537110137fc04aa0dab0f078c7..0f47d50957ac3e84a9ad19926aa33c6dba5a25bf 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_ana_log_len" 9 "nvme_get_ana_log_len" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_ana_log_len" 9 "nvme_get_ana_log_len" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_ana_log_len \- Retrieve size of the current ANA log
 .SH SYNOPSIS
index f68365ca19611c13fd36a6c9141b2d74919d7a45..f5c273f977b10b22e4915ac472fe3c0886ef3728 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_attr" 9 "nvme_get_attr" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_attr" 9 "nvme_get_attr" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_attr \- Read sysfs attribute
 .SH SYNOPSIS
index 04fb5e1b72bd2fd421ddffcc90298287c5907773..9c289990e063dbf129e153b800bdd29aa746cff4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_ctrl_attr" 9 "nvme_get_ctrl_attr" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_ctrl_attr" 9 "nvme_get_ctrl_attr" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_ctrl_attr \- Read controller sysfs attribute
 .SH SYNOPSIS
index 3ac2c8b047ecb3850bd6ce1295e6367ff68e5c33..33d5c16be8353592acbeae0a52563b30de475010 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_ctrl_telemetry" 9 "nvme_get_ctrl_telemetry" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_ctrl_telemetry" 9 "nvme_get_ctrl_telemetry" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_ctrl_telemetry \- Get controller telemetry log
 .SH SYNOPSIS
index 686d7cdf84ad5b8abe534cbc73901ae108d10eed..e38aca9d97220c0d459f389f5704149d8f2f37ff 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_directive_receive_length" 9 "nvme_get_directive_receive_length" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_directive_receive_length" 9 "nvme_get_directive_receive_length" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_directive_receive_length \- Get directive receive length
 .SH SYNOPSIS
diff --git a/doc/man/nvme_get_discovery_args.2 b/doc/man/nvme_get_discovery_args.2
new file mode 100644 (file)
index 0000000..d80b614
--- /dev/null
@@ -0,0 +1,35 @@
+.TH "libnvme" 9 "struct nvme_get_discovery_args" "October 2022" "API Manual" LINUX
+.SH NAME
+struct nvme_get_discovery_args \- Arguments for nvmf_get_discovery_wargs()
+.SH SYNOPSIS
+struct nvme_get_discovery_args {
+.br
+.BI "    nvme_ctrl_t c;"
+.br
+.BI "    int args_size;"
+.br
+.BI "    int max_retries;"
+.br
+.BI "    __u32 *result;"
+.br
+.BI "    __u32 timeout;"
+.br
+.BI "    __u8 lsp;"
+.br
+.BI "
+};
+.br
+
+.SH Members
+.IP "c" 12
+Discovery controller
+.IP "args_size" 12
+Length of the structure
+.IP "max_retries" 12
+Number of retries in case of failure
+.IP "result" 12
+The command completion result from CQE dword0
+.IP "timeout" 12
+Timeout in ms (default: NVME_DEFAULT_IOCTL_TIMEOUT)
+.IP "lsp" 12
+Log specific field (See enum nvmf_log_discovery_lsp)
index e41532056b1ea70e038a1d5f2382217c54dfd5ee..b176a0251c1a72e9fba32c846bbc2dc26f3c7ce2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_feature_length" 9 "nvme_get_feature_length" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_feature_length" 9 "nvme_get_feature_length" "October 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_feature_length2.2 b/doc/man/nvme_get_feature_length2.2
new file mode 100644 (file)
index 0000000..9a3d5a9
--- /dev/null
@@ -0,0 +1,24 @@
+.TH "nvme_get_feature_length2" 9 "nvme_get_feature_length2" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_get_feature_length2 \- Retreive the command payload length for a specific feature identifier
+.SH SYNOPSIS
+.B "int" nvme_get_feature_length2
+.BI "(int fid "  ","
+.BI "__u32 cdw11 "  ","
+.BI "enum nvme_data_tfr dir "  ","
+.BI "__u32 *len "  ");"
+.SH ARGUMENTS
+.IP "fid" 12
+Feature identifier, see \fIenum nvme_features_id\fP.
+.IP "cdw11" 12
+The cdw11 value may affect the transfer (only known fid is
+NVME_FEAT_FID_HOST_ID)
+.IP "dir" 12
+Data transfer direction: false - host to controller, true -
+controller to host may affect the transfer (only known fid is
+NVME_FEAT_FID_HOST_MEM_BUF).
+.IP "len" 12
+On success, set to this features payload length in bytes.
+.SH "RETURN"
+0 on success, -1 with errno set to EINVAL if the function did not
+recognize \fIfid\fP.
index bfa165f6e5885284663981b0ca1d496d6a4cc41d..98d10cee48b7e3e546d17272c8d3a02b309ee9eb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features" 9 "nvme_get_features" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features" 9 "nvme_get_features" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features \- Retrieve a feature attribute
 .SH SYNOPSIS
index 3dd2755548b20c817057d66b3287bf2bf7befaf5..d179153a5f5dbe957978558671fca0a424cd006e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_arbitration" 9 "nvme_get_features_arbitration" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_arbitration" 9 "nvme_get_features_arbitration" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_arbitration \- Get arbitration feature
 .SH SYNOPSIS
index 136083ddf42b4c054c5a866e709de22572a3dd3f..dd32249ae36a1b1f5d8b955dc744041f361efadf 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_async_event" 9 "nvme_get_features_async_event" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_async_event" 9 "nvme_get_features_async_event" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_async_event \- Get asynchronous event feature
 .SH SYNOPSIS
index 294185f6b910b8b52889718eefd30dcedfe0f394..3841101bc70f7a8e5654fe2394e07f7e8d688928 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_auto_pst" 9 "nvme_get_features_auto_pst" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_auto_pst" 9 "nvme_get_features_auto_pst" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_auto_pst \- Get autonomous power state feature
 .SH SYNOPSIS
index 5e521150cdc28b496e325d11a1079f7101e7d07f..2091ad662ebb9574367e98050273279f0f78db0c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_data" 9 "nvme_get_features_data" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_data" 9 "nvme_get_features_data" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_data \- Helper function for @nvme_get_features()
 .SH SYNOPSIS
index 5b75c927b2750151e709c3ed68fdfa3d4fe7953a..9ccac84f8123c72aad9b77519710a7118defb741 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_endurance_event_cfg" 9 "nvme_get_features_endurance_event_cfg" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_endurance_event_cfg" 9 "nvme_get_features_endurance_event_cfg" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_endurance_event_cfg \- Get endurance event config feature
 .SH SYNOPSIS
index 679f2010bb2a3557785fb24b33d16acb712f8b40..a40fe1bb767b1a986d3188574ec8237b2556d6c6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_err_recovery" 9 "nvme_get_features_err_recovery" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_err_recovery" 9 "nvme_get_features_err_recovery" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_err_recovery \- Get error recovery feature
 .SH SYNOPSIS
index bcdbcd231e1fce061ec12462dc32259833eb7a54..ede7b19fc6c70b26921b08b06d9c1e3c245cacc9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_hctm" 9 "nvme_get_features_hctm" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_hctm" 9 "nvme_get_features_hctm" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_hctm \- Get thermal management feature
 .SH SYNOPSIS
index 541042bd45a4ebb6751a805b8440d7232c77df36..608633650d0fd0f1a57abe9d4d1f2c8378a9960a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_host_behavior" 9 "nvme_get_features_host_behavior" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_host_behavior" 9 "nvme_get_features_host_behavior" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_host_behavior \- Get host behavior feature
 .SH SYNOPSIS
index f162e0289f47d089984d908ed60254e33eec8247..52a611aa5fb048d4ad811be925b575257d770434 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_host_id" 9 "nvme_get_features_host_id" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_host_id" 9 "nvme_get_features_host_id" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_host_id \- Get host id feature
 .SH SYNOPSIS
index 7a8816628a2495212ad7c8a20f5a1029b3745dd6..92eaf7547f98a935426a25bc14fafe0f3c3cf20d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_host_mem_buf" 9 "nvme_get_features_host_mem_buf" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_host_mem_buf" 9 "nvme_get_features_host_mem_buf" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_host_mem_buf \- Get host memory buffer feature
 .SH SYNOPSIS
index f1a78fe738a0977f57a7a1976563acfc3bed4da5..6a961a446dbcb758f6458e351b856225266ff852 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_iocs_profile" 9 "nvme_get_features_iocs_profile" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_iocs_profile" 9 "nvme_get_features_iocs_profile" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_iocs_profile \- Get IOCS profile feature
 .SH SYNOPSIS
index ade03a896e3038818443637296b3746990500e4e..f09f537bfe7d9ab9444f1cd6c0f470a6c5d7786c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_irq_coalesce" 9 "nvme_get_features_irq_coalesce" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_irq_coalesce" 9 "nvme_get_features_irq_coalesce" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_irq_coalesce \- Get IRQ coalesce feature
 .SH SYNOPSIS
index 2a6f9d41306921525f3fb714cfb0258c74d0aa29..f07d1b63e51f18f698683b7f0abdc68286c3fa9d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_irq_config" 9 "nvme_get_features_irq_config" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_irq_config" 9 "nvme_get_features_irq_config" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_irq_config \- Get IRQ config feature
 .SH SYNOPSIS
index c9b7e1e2d0a0675e30d95005af301bfe92218021..da3130c515dbb20a47378c0918ff1a307de507c7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_kato" 9 "nvme_get_features_kato" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_kato" 9 "nvme_get_features_kato" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_kato \- Get keep alive timeout feature
 .SH SYNOPSIS
index 861d375e5161f2060887ef7e249debab30d643ba..88ac73187684675581d07172a2e2bc89927b92ef 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_lba_range" 9 "nvme_get_features_lba_range" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_lba_range" 9 "nvme_get_features_lba_range" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_lba_range \- Get LBA range feature
 .SH SYNOPSIS
index 1361e02021d081b159f787ecfe30644d4c4b7b63..2c77cfc5df485d7e356958b74ee31609f30136c0 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_lba_sts_interval" 9 "nvme_get_features_lba_sts_interval" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_lba_sts_interval" 9 "nvme_get_features_lba_sts_interval" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_lba_sts_interval \- Get LBA status information feature
 .SH SYNOPSIS
index 3ac22cc25e5a1da875dae7498e2991c474b5dcbb..77109645cc452ea056b8d9bcc6f7d126196be4c7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_nopsc" 9 "nvme_get_features_nopsc" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_nopsc" 9 "nvme_get_features_nopsc" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_nopsc \- Get non-operational power state feature
 .SH SYNOPSIS
index 863638e71f7bf7d88c7f282f6d7593c4272b3f75..4a577a97400b4f887e311e3773dc83c165ef1daa 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_num_queues" 9 "nvme_get_features_num_queues" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_num_queues" 9 "nvme_get_features_num_queues" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_num_queues \- Get number of queues feature
 .SH SYNOPSIS
index 6911319d6e78b5167a498f92703781c4431bfdbe..ec2f5ce591a536125c7c01354eb906f1a6ea11f9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_plm_config" 9 "nvme_get_features_plm_config" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_plm_config" 9 "nvme_get_features_plm_config" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_plm_config \- Get predictable latency feature
 .SH SYNOPSIS
index 14095d1e1bf4c30104c9920589bd13b7cc2add90..1b653a9373705068e75decfcee217382aa483852 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_plm_window" 9 "nvme_get_features_plm_window" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_plm_window" 9 "nvme_get_features_plm_window" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_plm_window \- Get window select feature
 .SH SYNOPSIS
index c89fcec68002e31be4d05a920619b732ae377a2d..75f7a01288ad8b0d08ba7b0e265a62e6dfd2ba68 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_power_mgmt" 9 "nvme_get_features_power_mgmt" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_power_mgmt" 9 "nvme_get_features_power_mgmt" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_power_mgmt \- Get power management feature
 .SH SYNOPSIS
index 815dc8d11b82263b6c32c39dbb3588d25b02cfcb..059ae3b99596c5ec073bda9032bf92c0f1776885 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_resv_mask" 9 "nvme_get_features_resv_mask" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_resv_mask" 9 "nvme_get_features_resv_mask" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_resv_mask \- Get reservation mask feature
 .SH SYNOPSIS
index 3b7315ce3c2610baa919d36402e8a5c7e20fce6a..5634e9eab72e04d4a5ee52f85519516754169383 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_resv_persist" 9 "nvme_get_features_resv_persist" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_resv_persist" 9 "nvme_get_features_resv_persist" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_resv_persist \- Get reservation persist feature
 .SH SYNOPSIS
index 1cde710fc59ecbf57e43fa1ac6a18e20292cfe82..a20b8fcba1ae65765faa87a9b049f89904134efa 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_rrl" 9 "nvme_get_features_rrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_rrl" 9 "nvme_get_features_rrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_rrl \- Get read recovery level feature
 .SH SYNOPSIS
index 625f014679af1c81cf398dc4da2ab119992c6c60..b5869ec0cab2ba0a82657c165dd83db6a648ba94 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_sanitize" 9 "nvme_get_features_sanitize" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_sanitize" 9 "nvme_get_features_sanitize" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_sanitize \- Get sanitize feature
 .SH SYNOPSIS
index 2eff9b70a0e3527b6d984890d0e8a1227a6de08c..7381831c339193167a1d6566bb0d0bad14ad9ad1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_get_features_sel" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_get_features_sel" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_get_features_sel \- Get Features - Select
 .SH SYNOPSIS
index 8712cf77d520b1a174fa76ad322b463e9524d56d..e5281142773fd00daeb68115dcda5d6968f8b41e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_simple" 9 "nvme_get_features_simple" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_simple" 9 "nvme_get_features_simple" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_simple \- Helper function for @nvme_get_features()
 .SH SYNOPSIS
index b3f9d74c7c2aa5e577daed64e86f5bc4b0e3c92a..745221c0bdfa04f0405e8634ce73a2197131d477 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_sw_progress" 9 "nvme_get_features_sw_progress" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_sw_progress" 9 "nvme_get_features_sw_progress" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_sw_progress \- Get software progress feature
 .SH SYNOPSIS
index 7d6cca896bdff214c9b899f9715b72ebdf672fd4..30d0e9784b8cbabd57157c914a9cae48298b381a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_temp_thresh" 9 "nvme_get_features_temp_thresh" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_temp_thresh" 9 "nvme_get_features_temp_thresh" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_temp_thresh \- Get temperature threshold feature
 .SH SYNOPSIS
index 10518bdfb5992b01176b9953e38f8fced1282899..d8c6503ae2072fffbf87830903e4e788a4c6a666 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_timestamp" 9 "nvme_get_features_timestamp" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_timestamp" 9 "nvme_get_features_timestamp" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_timestamp \- Get timestamp feature
 .SH SYNOPSIS
index 3d05971b1d0a9bc67f693b9bae1f3181e89f347f..76db21e5def2497d92a98a6565cfe616cafcd50b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_volatile_wc" 9 "nvme_get_features_volatile_wc" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_volatile_wc" 9 "nvme_get_features_volatile_wc" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_volatile_wc \- Get volatile write cache feature
 .SH SYNOPSIS
index 2dbbce3b69c43222fdd3d90cfd97f4b5344ad44e..8d4d814310d4f245216862c80536efcb9fc1c82d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_write_atomic" 9 "nvme_get_features_write_atomic" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_write_atomic" 9 "nvme_get_features_write_atomic" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_write_atomic \- Get write atomic feature
 .SH SYNOPSIS
index 63e81ff7410a43248eb64231f8b23fa1e7a18259..4ad6411ee0a2876b7803e5a352f956abdfef7962 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_features_write_protect" 9 "nvme_get_features_write_protect" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_features_write_protect" 9 "nvme_get_features_write_protect" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_features_write_protect \- Get write protect feature
 .SH SYNOPSIS
index 6d78fff22c1a8fcd6059e70e0adaea67e2ad6aa6..c5df379b67d03ce3f41b299776e2c17f27cdbf00 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_host_telemetry" 9 "nvme_get_host_telemetry" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_host_telemetry" 9 "nvme_get_host_telemetry" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_host_telemetry \- Get host telemetry log
 .SH SYNOPSIS
index 3ee965c91c1a3af5b29ccbd833b946b654719204..cab0c57cb119021dad020b1cf756235708fa7647 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_lba_status" 9 "nvme_get_lba_status" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_lba_status" 9 "nvme_get_lba_status" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_lba_status \- Retrieve information on possibly unrecoverable LBAs
 .SH SYNOPSIS
index 860e4b8d0240e5f3b360e9b7841c7bb54a64edda..449088088abef820620ca89bbbcb2b59d39c8836 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_lba_status_log" 9 "nvme_get_lba_status_log" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_lba_status_log" 9 "nvme_get_lba_status_log" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_lba_status_log \- Retrieve the LBA Status log page
 .SH SYNOPSIS
index 86b5a829adb351b3b1900aa184bdb425547b3e46..5c9f50c45feac35b5e75b0f4ae0c2839a93368d1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log" 9 "nvme_get_log" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log" 9 "nvme_get_log" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log \- NVMe Admin Get Log command
 .SH SYNOPSIS
index f26ee0e0d1aceed81909dfec0f1e9c8842ac8bda..46d09318df40188b3c45ecbae8dfc01cc59a9dae 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_ana" 9 "nvme_get_log_ana" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_ana" 9 "nvme_get_log_ana" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_ana \- Retrieve Asymmetric Namespace Access log page
 .SH SYNOPSIS
index 89e7bfa76b450ad16b77c6139867d7af2e20bf99..6f4a07cf18b736c3925cb3b0075d0359eccea5da 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_ana_groups" 9 "nvme_get_log_ana_groups" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_ana_groups" 9 "nvme_get_log_ana_groups" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_ana_groups \- Retrieve Asymmetric Namespace Access groups only log page
 .SH SYNOPSIS
index d40fba864314e71fbca81a03e180871463f345d2..b8d65b04ec66f13cab297b9332d03f83fa5ceba2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_boot_partition" 9 "nvme_get_log_boot_partition" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_boot_partition" 9 "nvme_get_log_boot_partition" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_boot_partition \- Retrieve Boot Partition
 .SH SYNOPSIS
index 1cd36d694169b73515217e3d1f5b28ae6e88dba0..9ce502ef135ecf1713a41e239d0761c0d0d564eb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_changed_ns_list" 9 "nvme_get_log_changed_ns_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_changed_ns_list" 9 "nvme_get_log_changed_ns_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_changed_ns_list \- Retrieve namespace changed list
 .SH SYNOPSIS
index 8a06c8ad99b3f56cc85af8e9116003f46883d196..a5a78b0c7535060890a2d71ed5f7b6af72875ad5 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_cmd_effects" 9 "nvme_get_log_cmd_effects" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_cmd_effects" 9 "nvme_get_log_cmd_effects" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_cmd_effects \- Retrieve nvme command effects log
 .SH SYNOPSIS
index c9313b078c30dbb722f5e4221ac9ce3ce8f340c7..feae35b75e59cfa80ed3f5297cb3c05404462765 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_create_telemetry_host" 9 "nvme_get_log_create_telemetry_host" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_create_telemetry_host" 9 "nvme_get_log_create_telemetry_host" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_create_telemetry_host \- Create host telemetry log
 .SH SYNOPSIS
index 0daddcaa5c309b3921bfda33d2be80bdbb2cb516..710f0a0ede42f4ba54eb84449280c4578767c896 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_device_self_test" 9 "nvme_get_log_device_self_test" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_device_self_test" 9 "nvme_get_log_device_self_test" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_device_self_test \- Retrieve the device self test log
 .SH SYNOPSIS
index 761dfc60fde90765efe980f3c7cf6ef4f1c0270c..3954a136d576e00d70a66b97bad1e2a913c6da6b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_discovery" 9 "nvme_get_log_discovery" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_discovery" 9 "nvme_get_log_discovery" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_discovery \- Retrieve Discovery log page
 .SH SYNOPSIS
index 99af510445765f213ec51dd3576dba9346d4ce66..7690ec7b98a040ea1418ae0ebe1b6e2ce046e8c2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_endurance_group" 9 "nvme_get_log_endurance_group" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_endurance_group" 9 "nvme_get_log_endurance_group" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_endurance_group \- Get Endurance Group log
 .SH SYNOPSIS
index 56eb3329acfbce3c82aac130a92bc460f73001b2..2be5ff34469df7f474300606bf2a74b0de9a30aa 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_endurance_grp_evt" 9 "nvme_get_log_endurance_grp_evt" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_endurance_grp_evt" 9 "nvme_get_log_endurance_grp_evt" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_endurance_grp_evt \- Retrieve Rotational Media Information
 .SH SYNOPSIS
index a923da1b2aabafb05f89f29c9d11697621126735..09bdd324dff09c4fbe3ba816f08a221684c2b9c8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_error" 9 "nvme_get_log_error" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_error" 9 "nvme_get_log_error" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_error \- Retrieve nvme error log
 .SH SYNOPSIS
index 9944914c151fdcc103a771d8054a27191d84eb70..7b4b8e5e949ae022d3b7c55c47d2d1336dd96f1a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_fid_supported_effects" 9 "nvme_get_log_fid_supported_effects" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_fid_supported_effects" 9 "nvme_get_log_fid_supported_effects" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_fid_supported_effects \- Retrieve Feature Identifiers Supported and Effects
 .SH SYNOPSIS
index bc52c587362c50d133831cad80ec4645cd67cf41..2792ba63c93085be5cbe8a41683a13f163fb6739 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_fw_slot" 9 "nvme_get_log_fw_slot" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_fw_slot" 9 "nvme_get_log_fw_slot" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_fw_slot \- Retrieves the controller firmware log
 .SH SYNOPSIS
index 8e23341b53e405da245c444163fcb1fd7bb46ca5..723e6b11c2b87d342ce3c0acaaf06971c6c9f4d3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_lba_status" 9 "nvme_get_log_lba_status" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_lba_status" 9 "nvme_get_log_lba_status" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_lba_status \- Retrieve LBA Status
 .SH SYNOPSIS
index 7480e0899409dfafd8cbbfbe0b1b0783d5c36b21..117034b33d6a56211c73dcbd20d182704f0dd8bf 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_media_unit_stat" 9 "nvme_get_log_media_unit_stat" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_media_unit_stat" 9 "nvme_get_log_media_unit_stat" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_media_unit_stat \- Retrieve Media Unit Status
 .SH SYNOPSIS
index 23abcbee222e391ffb401dc4ed4ad36d14281755..c153f1dd1f786a4764f825d0b6ca854dfbb507c4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_mi_cmd_supported_effects" 9 "nvme_get_log_mi_cmd_supported_effects" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_mi_cmd_supported_effects" 9 "nvme_get_log_mi_cmd_supported_effects" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_mi_cmd_supported_effects \- displays the MI Commands Supported by the controller
 .SH SYNOPSIS
index 773645cc8a95c8ac0f79f96ee00c121f9a384e46..bff7063c2140b61104e37e6ba5d6baabb2b4bc11 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_page" 9 "nvme_get_log_page" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_page" 9 "nvme_get_log_page" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_page \- Get log page data
 .SH SYNOPSIS
index c1d215f99c0c5830694984b3231cc75ec1d1ec6c..168e4e9e1b02f25be3bc3bed8821a8edf0f88db1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_persistent_event" 9 "nvme_get_log_persistent_event" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_persistent_event" 9 "nvme_get_log_persistent_event" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_persistent_event \- Retrieve Persistent Event Log
 .SH SYNOPSIS
index 09ff28931d6e05f99b736a7c8fc19bb662cd3cc7..ca8a07176f931e56df9b24be4fabcb3f4e17e312 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_predictable_lat_event" 9 "nvme_get_log_predictable_lat_event" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_predictable_lat_event" 9 "nvme_get_log_predictable_lat_event" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_predictable_lat_event \- Retrieve Predictable Latency Event Aggregate Log Page
 .SH SYNOPSIS
index f0525cf27b32ad1658ce6c4508ce062bb241cdc4..653e807eb2d90b6de1d3ef9a92704ed0e5ff26e1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_predictable_lat_nvmset" 9 "nvme_get_log_predictable_lat_nvmset" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_predictable_lat_nvmset" 9 "nvme_get_log_predictable_lat_nvmset" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_predictable_lat_nvmset \- Predictable Latency Per NVM Set
 .SH SYNOPSIS
index 21032c4d2e3e9a8f57724dfad6edaed93a1bb4a1..ec14ee49e9f3d01de0a1e5d56d38f6001a95968c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_reservation" 9 "nvme_get_log_reservation" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_reservation" 9 "nvme_get_log_reservation" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_reservation \- Retrieve Reservation Notification
 .SH SYNOPSIS
index 2b4afa43ee948958cf55ff638eaf29beb7ff5dd6..bc935bd2492aca5e8bfab79820d834a05f3f5ce5 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_sanitize" 9 "nvme_get_log_sanitize" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_sanitize" 9 "nvme_get_log_sanitize" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_sanitize \- Retrieve Sanitize Status
 .SH SYNOPSIS
index 5d3f74f0a1cda3b346e0ea477a5f4ced6cfd9f2c..3f232ad1c2a856c5dbee4cb16a7ffa49d0e302b7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_smart" 9 "nvme_get_log_smart" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_smart" 9 "nvme_get_log_smart" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_smart \- Retrieve nvme smart log
 .SH SYNOPSIS
index a7239baa84545ba7c274575e136f8a71ec15a5b2..f0a94a353a9b2969f2e6a9881156e632d4ad674f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_support_cap_config_list" 9 "nvme_get_log_support_cap_config_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_support_cap_config_list" 9 "nvme_get_log_support_cap_config_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_support_cap_config_list \- Retrieve Supported Capacity Configuration List
 .SH SYNOPSIS
index 2e32b04f73dfb0a6b7b79c91aba9b5b1a3d7919c..832a566b3ed9d1ba1ca06288ec354ae048a91028 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_supported_log_pages" 9 "nvme_get_log_supported_log_pages" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_supported_log_pages" 9 "nvme_get_log_supported_log_pages" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_supported_log_pages \- Retrieve nmve supported log pages
 .SH SYNOPSIS
index 40399173e725cf8b0e359197a0a85db208c29347..110dab09233e88157893734142ea1a29fc13251e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_telemetry_ctrl" 9 "nvme_get_log_telemetry_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_telemetry_ctrl" 9 "nvme_get_log_telemetry_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_telemetry_ctrl \- Get Telemetry Controller-Initiated log page
 .SH SYNOPSIS
index 43bc5dc66d9266e720e52be774a63cf0b3a1437a..56cabaeb4e51238705abe665a5a4c40f9dca1169 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_telemetry_host" 9 "nvme_get_log_telemetry_host" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_telemetry_host" 9 "nvme_get_log_telemetry_host" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_telemetry_host \- Get Telemetry Host-Initiated log page
 .SH SYNOPSIS
index 1b2f4400d97ca8d20dbb9e6c3aecd05c295514b0..10906fab05b151967e4e365360af3f0422249308 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_log_zns_changed_zones" 9 "nvme_get_log_zns_changed_zones" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_log_zns_changed_zones" 9 "nvme_get_log_zns_changed_zones" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_log_zns_changed_zones \- Retrieve list of zones that have changed
 .SH SYNOPSIS
index 66fdf64071b2d103434f084b05f09f4635274602..5a86abbb3ca19758cc114cddf7dcb63d0f0f55ac 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_logical_block_size" 9 "nvme_get_logical_block_size" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_logical_block_size" 9 "nvme_get_logical_block_size" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_logical_block_size \- Retrieve block size
 .SH SYNOPSIS
index 3766f3c2fc920fc6082736bd63411ca91735f3b8..90f3210d2a985b2a808fe2d5dccd070d6102b063 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_new_host_telemetry" 9 "nvme_get_new_host_telemetry" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_new_host_telemetry" 9 "nvme_get_new_host_telemetry" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_new_host_telemetry \- Get new host telemetry log
 .SH SYNOPSIS
index 5b5abb6f5df782ed56b3f0ad808c408d011b1fdb..bf9977dae5a14542ad7f02726807b80460c69a2d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_ns_attr" 9 "nvme_get_ns_attr" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_ns_attr" 9 "nvme_get_ns_attr" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_ns_attr \- Read namespace sysfs attribute
 .SH SYNOPSIS
index d0b4a9c799172d0575d409d12a3f10553d05ccfe..ece18ecda0316091b81de1c21058b20988bdb46d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_nsid" 9 "nvme_get_nsid" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_nsid" 9 "nvme_get_nsid" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_nsid \- Retrieve the NSID from a namespace file descriptor
 .SH SYNOPSIS
index ca6dce4bd1e6130a9bdd4060ad17214c8405190f..e7044a40b5d9bef503bc516a56e531ab862d5162 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_path_attr" 9 "nvme_get_path_attr" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_path_attr" 9 "nvme_get_path_attr" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_path_attr \- Read path sysfs attribute
 .SH SYNOPSIS
index 4f2c040e363b7ae6b9d34a8b4e41df6bdd9f6fa9..bad5b54403eb8649dad79164268f37b46713339a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_property" 9 "nvme_get_property" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_property" 9 "nvme_get_property" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_property \- Get a controller property
 .SH SYNOPSIS
index a9cf272b1d723830962d1afaf0d7cacdcb1da36c..39d632de836726216546f1a5a28fe468661d5cfd 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_get_subsys_attr" 9 "nvme_get_subsys_attr" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_get_subsys_attr" 9 "nvme_get_subsys_attr" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_get_subsys_attr \- Read subsystem sysfs attribute
 .SH SYNOPSIS
index e4785746594474522c34a821899f3f462c7cbfb9..e2699d9fbcffac58f7c579447e9e1c1a58f2d994 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_hmac_alg" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_hmac_alg" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_hmac_alg \- HMAC algorithm
 .SH SYNOPSIS
index 8c22a36fa49c26760b2900b4f2d5b98042ca19f2..dc6f2c92feb41633d0b164e5fa4496256df447ae 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_host_behavior_support" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_host_behavior_support" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_host_behavior_support \- Enable Advanced Command
 .SH SYNOPSIS
index 657436f166ea472e757000de5d4ee16796e7296e..5eabfd3522b529e2fe1005019c8a292b1e2d7339 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_host_get_dhchap_key" 9 "nvme_host_get_dhchap_key" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_host_get_dhchap_key" 9 "nvme_host_get_dhchap_key" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_host_get_dhchap_key \- Return host key
 .SH SYNOPSIS
index 58db7817bcb35ea4bfb60c05febc2a3fdacec2b3..afa617812896377cc44f44b6dd8d05484a126f4e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_host_get_hostid" 9 "nvme_host_get_hostid" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_host_get_hostid" 9 "nvme_host_get_hostid" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_host_get_hostid \- Host ID of an nvme_host_t object
 .SH SYNOPSIS
index d55490491c37795b11814878b52b8a33b0be7e45..0c897d681920a7fa5ae5fb436cc3d2e5974420f8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_host_get_hostnqn" 9 "nvme_host_get_hostnqn" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_host_get_hostnqn" 9 "nvme_host_get_hostnqn" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_host_get_hostnqn \- Host NQN of an nvme_host_t object
 .SH SYNOPSIS
index b22d56e8653017dd703922e0695a60c8b8c1b9f1..c021b562cc8cd5e312e7dc5a2efbdf485bd37724 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_host_get_hostsymname" 9 "nvme_host_get_hostsymname" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_host_get_hostsymname" 9 "nvme_host_get_hostsymname" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_host_get_hostsymname \- Get the host's symbolic name
 .SH SYNOPSIS
index c405fb48cd4bd73a168fa781e2387a8451aaf136..29a74b0ef0dc94c5d245cf88df0e2a1ba8e5b2a4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_host_get_root" 9 "nvme_host_get_root" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_host_get_root" 9 "nvme_host_get_root" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_host_get_root \- Returns nvme_root_t object
 .SH SYNOPSIS
index abf2cdd0fe52caf0d8b4f99ec242af92f9f25dac..9d4da55a494fe8dff0fdf26215a295f5d912a52a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_host_mem_buf_attrs" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_host_mem_buf_attrs" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_host_mem_buf_attrs \- Host Memory Buffer - Attributes Data Structure
 .SH SYNOPSIS
index 213d87ba87a2b8001a80fce071626c377f7c1e33..c329d95693e29f1244886b77318677555d4520e8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_host_metadata" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_host_metadata" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_host_metadata \- Host Metadata Data Structure
 .SH SYNOPSIS
index 5e6fbf9465f4a936e9f2620b1af92e879096737a..96704fa5b4ada0c13ae12f8bdf78f3f2749be5b6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_host_set_dhchap_key" 9 "nvme_host_set_dhchap_key" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_host_set_dhchap_key" 9 "nvme_host_set_dhchap_key" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_host_set_dhchap_key \- set host key
 .SH SYNOPSIS
index d7822cf4c0e77ac95a5f20da0b7c25118eb6c812..f8b372569fb9576c68f9122eba19edc5b20e35c0 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_host_set_hostsymname" 9 "nvme_host_set_hostsymname" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_host_set_hostsymname" 9 "nvme_host_set_hostsymname" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_host_set_hostsymname \- Set the host's symbolic name
 .SH SYNOPSIS
index e057d7ca9b7beb574e57f862a87ad3e5e75d2a0e..9d0661f42efe9d44c8ff5540ac81bd58b97d37cc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_ctrl" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_ctrl" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_ctrl \- Identify Controller data structure
 .SH SYNOPSIS
index fdb83d9de0df6f1762d2d2b83d6a008026d5587a..7046e5c7e71116bc0fe136a4460b3f139ab2cc26 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_anacap" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_anacap" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_anacap \- This field indicates the capabilities associated with Asymmetric Namespace Access Reporting.
 .SH SYNOPSIS
index 7e88fcf55def52576e6e2f409e1e839c09ef1cc9..bf40d5d190957e2467ef270018ec4e4fb945faa3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_apsta" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_apsta" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_apsta \- Flags indicating the attributes of the autonomous power state transition feature.
 .SH SYNOPSIS
index 08bd8b850b193f0ca45a3c32dfd07e77620cd855..138534e7fee24478058e57e7875a94db3b6fac37 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_avscc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_avscc" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_avscc \- Flags indicating the configuration settings for Admin Vendor Specific command handling.
 .SH SYNOPSIS
index 86cdb6c0204ec4ae8e498afa2fb64e2daafc872e..4a9c640926df723df7e73183a78b450bc330a78b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_cmic" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_cmic" "October 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
index b65bbfaca90f076221110af5d6740ea58578e51f..49af0165fbd146c926ab50000bb7cec5faa5aed4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_cntrltype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_cntrltype" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_cntrltype \- Controller types
 .SH SYNOPSIS
index 18e0612b884de1665a152b54462a1d775e662b7e..a5d39b3411dcc738627710a7e715aef8e7a28b9c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_cqes" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_cqes" "October 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
index a2ee992a0ed2bbefea5e90aaa501046eb064d0ff..3e98d880dbd805c61e7689435a045bc4444dbf8a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_ctratt" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_ctratt" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_ctratt \- Controller attributes
 .SH SYNOPSIS
index 2a993cd4404e84a6c0995a61fa73b9655d08001c..c7ac74b4ab39d13b3af7d8fce4882f417500e4b2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_dctype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_dctype" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_dctype \- Discovery Controller types
 .SH SYNOPSIS
index 885ba573dfedb6b44d5ddc8d4bcbd8a9ab63b703..7d365bb737631156652fe7a6dbe706ec88e549a0 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_dsto" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_dsto" "October 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
index 458f68bc55d7177399ea2c0f3c97e1317030dc07..1642213dcee5eeba17ba67a8e4abd5a35549904f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_fcatt" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_fcatt" "October 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
index 31a97bccf92d3e8e6b3a5deb2f4a0c48150af31b..edbd3d6aaecb60839ae6710466d5bbe43a82801b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_fna" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_fna" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_fna \- This field indicates attributes for the Format NVM command.
 .SH SYNOPSIS
index 02d4fadece6a85527d11d33af3354d4e1b975c34..533dbf8cb83246724b8661af8f2e2e6d53ad24ec 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_frmw" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_frmw" "October 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
index 2d2ce7026a6d5d7610d67e67bf1af5996b00a4f9..272c604817bc21093414996d97fe21a8cffb9a73 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_fuses" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_fuses" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_fuses \- This field indicates the fused operations that the controller supports.
 .SH SYNOPSIS
index b247be0675e2bd88ed87e04b6117b0ed72fa54e6..9d1106c8b9200c4943d95714e6e341a81a08f606 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_hctm" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_hctm" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_hctm \- Flags indicate the attributes of the host controlled thermal management feature
 .SH SYNOPSIS
index 1bfc6113d984871e404e4f70caac5e7c5061c74c..fc29d73025915f22a1d0d3fdc69a72ec86186d70 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_lpa" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_lpa" "October 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
index f0b6f3f59a26fef3dbb4eb28aab25bb5ed5d0e38..f26c44357d912f8eb82312bcefedba0024d2d7ca 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_mec" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_mec" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_mec \- Flags indicating the capabilities of the Management Endpoint in the Controller, &struct nvme_id_ctrl.mec.
 .SH SYNOPSIS
index 28060bd0440862c931104983392b80ddac0b82de..46395785cb5f462b652ee88de1c35cbfe48db21b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_ctrl_nvm" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_ctrl_nvm" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_ctrl_nvm \- I/O Command Set Specific Identify Controller data structure
 .SH SYNOPSIS
index a8516265ddc8e39de60331db005bf5ea1a074fce..52e2581d58ca8f45eb4b5249a6300fa283513ec3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_nvmsr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_nvmsr" "October 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
index a5bf11727309b120e3c8e1dd77ebe784b83f2f12..a04d0034b5b2b37610167301a1b53cb6ffd9ec5f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_nvscc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_nvscc" "October 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
index 48699d1f0f5621ce51c6da143e42f2004a61dd5a..05d915c328b96db579df41854298f96e7b15ac6b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_nwpc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_nwpc" "October 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
index f06c95a5777a645a584e67099b3b96da3a771931..b67818fe5c5fee86dea3ae747350ebad82f47c84 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_oacs" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_oacs" "October 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
index 7257cb45720b8c1c5f902a89b0ea118661564c6b..9b065b205a862d4be5dd74d27ec4a1f2097ba31a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_oaes" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_oaes" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_oaes \- Optional Asynchronous Events Supported
 .SH SYNOPSIS
index b93374ee7bbcba301af5ad128a31eecd9b238d60..e3c8a47b0e7427823e1ef4d9c6bac9f4f25099f8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_ofcs" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_ofcs" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_ofcs \- Indicate whether the controller supports optional fabric commands.
 .SH SYNOPSIS
index e9125160a0a9b7f250b0ff3d6c18d9bbb404d063..011fc5c63ca17e1f1d585aa5e6ebb2f10c11d435 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_oncs" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_oncs" "October 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
index 6dfcdd28216d177a76c4be1928971b9952bd3826..52ff2669d0c34e1ebef29e4d76b79b567a64bbc8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_rpmbs" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_rpmbs" "October 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
index bf9ad69e0fa337226b5570594a6e3ab0d258367d..1a6456f8e97537f72292b52fb68003da15cc22f0 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_sanicap" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_sanicap" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_sanicap \- Indicates attributes for sanitize operations.
 .SH SYNOPSIS
index a486713eaaa0781a2740ef811c00ede76fd2c88e..fdfba0594412055898291ef470f7d2163569db96 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_sgls" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_sgls" "October 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
index 9358f772eaeceda67b78065b8071aac62849f77e..4135fe8a27036c8133856349f32cf55c8c56e8e8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_sqes" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_sqes" "October 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
index ea196f376d878c4e7303396ac9758e7669de0b6d..3a36864f9fa0481e63b0f06171df9ca8da749e0a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_vwc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_vwc" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ctrl_vwc \- Volatile write cache
 .SH SYNOPSIS
index e0b075c95405e439daf167cfd2a846e901b9a5cd..53283c9e8f9750c9620f7316712fea3b61c421d6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ctrl_vwci" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ctrl_vwci" "October 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
index f04d12ff9064e543dd9ccdcb0d515d59a2c09e16..63267f66487d937d3d3298203879e8c9b0deb1db 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_directives" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_directives" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_directives \- Identify Directive - Return Parameters Data Structure
 .SH SYNOPSIS
index f660cb8c84a0ec9953586f388a8642ce9de4f2ae..1998ba36ab9308655090c215d6941ddaae4d9310 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_domain_attr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_domain_attr" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_domain_attr \- Domain Attributes Entry
 .SH SYNOPSIS
index d8dfb1169c4e6c2a3f7912883a719b3e0a0fd3eb..95b0a9984ab9d58117a9a1c2c221fce17403811a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_domain_list" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_domain_list" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_domain_list \- Domain List
 .SH SYNOPSIS
index 88317bf51c9a4404b29c9c88b0ec0b93e34b3f6f..94cd512ff62bf6d77a3a12c7ae784be6911648ce 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_endurance_group_list" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_endurance_group_list" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_endurance_group_list \- Endurance Group List
 .SH SYNOPSIS
index 9dce1b252f4894338b47a7a9825cba9bb7b2a769..704ed39185a27c4926450ab9b9df631d90ba7b0c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_independent_id_ns" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_independent_id_ns" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_independent_id_ns \- Identify - I/O Command Set Independent Identify Namespace Data Structure
 .SH SYNOPSIS
index c691f1443e0260b55422b899f6d27d8dec4add97..4145e1769e25ad3dc9406002a7ab18109b7a4a57 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_iocs" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_iocs" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_iocs \- NVMe Identify IO Command Set data structure
 .SH SYNOPSIS
index 6431f8e7f7304952a7c154799e7cc785ec8fb7a7..ce284d80ef0528f4c58f25d8d97997df18f8e037 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_ns" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_ns" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_ns \- Identify Namespace data structure
 .SH SYNOPSIS
index e56f12249964f403e429d449e7d7b0ac2d47531a..324faf01668dcb91093e1923f45007c85da4bfd5 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ns_attr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_attr" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ns_attr \- Specifies attributes of the namespace.
 .SH SYNOPSIS
index 749fa361ed5c963d3d113a0f8ffeaa373ef79a07..6d98a2a420d0a160ff34a748b4617f13f3f8cfb1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ns_dlfeat" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_dlfeat" "October 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
index 40093ed289d62a17e8ab7f23b65595ead53445be..57faa6faed45ca27f4f954b41c4c0b32837b35c4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ns_dpc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_dpc" "October 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
index bc7c1a62567d3c315eed51f9652b10cdae2bdda1..ebd45d5cd656cc05e7f3da0b847a8361256311f6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ns_dps" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_dps" "October 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
index c65b5de7e7ba0973869ea66896e77446ed2dc543..4d553846969e5d0c7fd84f58f746ad14297dc933 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ns_flbas" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_flbas" "October 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
index 96303bf952c992957651ebb66ddcb304d46acecb..1a3c8f3a9fbf3cc88674193f0cff745ebb005b9a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_ns_granularity_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_ns_granularity_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_ns_granularity_desc \- Namespace Granularity Descriptor
 .SH SYNOPSIS
index 5245b1a84c77f37821155ebe511fdb962cf2aa37..d4da19d39ea94921b4d613d5c731246c877d9171 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_ns_granularity_list" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_ns_granularity_list" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_ns_granularity_list \- Namespace Granularity List
 .SH SYNOPSIS
index 21bb73b045b62cb819793458d1d90698690303ad..129614a7e0b51113b41e4fff00f545ce4606bef6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ns_mc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_mc" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ns_mc \- This field indicates the capabilities for metadata.
 .SH SYNOPSIS
index f4400e92314851c288e94e9d5f6325a8ada65779..b27318ea62311551cc3c52493524808799ec3b92 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ns_nmic" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_nmic" "October 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
index 8fc112f3c6b652426756ae80e7930270e298d276..ccdeecd5438f7a6f8601aadcca70f241212cd548 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_ns_rescap" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_ns_rescap" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_ns_rescap \- This field indicates the reservation capabilities of the namespace.
 .SH SYNOPSIS
index 7499cd2913a277f078f74e87093353d56081e821..881ee8f78190a78f1c006cb53db5c90b66d5f1f8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_nsfeat" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_nsfeat" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_nsfeat \- This field defines features of the namespace.
 .SH SYNOPSIS
index 90be349173f2dc225d425d215f46dab208499a8d..664645897d75a165ce29552038dd45dbbb9cd8b3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_nvmset_list" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_nvmset_list" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_nvmset_list \- NVM set list
 .SH SYNOPSIS
index c45e0ce11a9674f5a575f993593776ec0f47bdb2..3e4864d5784a1f4a1c1d1651d0575d37ab12c277 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_psd" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_psd" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_psd \- Power Management data structure
 .SH SYNOPSIS
index 933719dcdb9a5fb8d4a987e0299bdc7c995c4d18..41ca728b7df0c8fe454a438a61c2b79bb4a4d9d4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_id_uuid" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_id_uuid" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_id_uuid \- Identifier Association
 .SH SYNOPSIS
index 56a0957f2da8b78cdad648f3766c0af4b9670088..224327980b8710a9d82ef08499c46b25b05875ab 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_uuid_list" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_uuid_list" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_uuid_list \- UUID list
 .SH SYNOPSIS
index 9486ff4f23e551ce94dd5df19b87f50016741fdf..c194b785a49874eb161451f542fd3af17c5923db 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_id_uuid_list_entry" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_id_uuid_list_entry" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_id_uuid_list_entry \- UUID List Entry
 .SH SYNOPSIS
index 10cfa3d12c64038d3109b6a279c9e243a4bc8b7e..b0cf0672e6d9913495e6cb42148708acdbe87dbe 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify" 9 "nvme_identify" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify" 9 "nvme_identify" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify \- Send the NVMe Identify command
 .SH SYNOPSIS
index d82faac1cc7d88701bdeaa03244aa61ceec7ff09..8f9b4128a825155ceda247a4af01550997e03914 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_active_ns_list" 9 "nvme_identify_active_ns_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_active_ns_list" 9 "nvme_identify_active_ns_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_active_ns_list \- Retrieves active namespaces id list
 .SH SYNOPSIS
index 226a8bbcad0b240608359b083a076629ee440133..a87020caa298856658ba4469b5da031b10e8c94d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_active_ns_list_csi" 9 "nvme_identify_active_ns_list_csi" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_active_ns_list_csi" 9 "nvme_identify_active_ns_list_csi" "October 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
index cec9f1cb3c739dc869ec0b00599e332e64673254..b4766ff2a5102dd7723994e863584258d3228c20 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_allocated_ns" 9 "nvme_identify_allocated_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_allocated_ns" 9 "nvme_identify_allocated_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_allocated_ns \- Same as nvme_identify_ns, but only for allocated namespaces
 .SH SYNOPSIS
index 4741560363f290f240382b3b8249ce7aa8d5d202..15d9129df0cb21a1dc9d249c1256be01de81874b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_allocated_ns_list" 9 "nvme_identify_allocated_ns_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_allocated_ns_list" 9 "nvme_identify_allocated_ns_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_allocated_ns_list \- Retrieves allocated namespace id list
 .SH SYNOPSIS
index 1c5b69e57debdbdb0e5fc91b6f0e1cbafbaaf4bf..a444b3364d68f420aa71c3290f90ebccad7a2317 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_allocated_ns_list_csi" 9 "nvme_identify_allocated_ns_list_csi" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_allocated_ns_list_csi" 9 "nvme_identify_allocated_ns_list_csi" "October 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
index 6d1f70799c50748906c882ea38803259f501b7d2..1d11ffbc9e7bb737e7e26f647e62f5b7fc739247 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_identify_cns" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_identify_cns" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_identify_cns \- Identify - CNS Values
 .SH SYNOPSIS
index e88ead46da05352b0df99fa8028f472ef0d8fc23..606831b7af8a638eda0f2497d72433c6916b9f69 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_ctrl" 9 "nvme_identify_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_ctrl" 9 "nvme_identify_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_ctrl \- Retrieves nvme identify controller
 .SH SYNOPSIS
index 05636782773a3ceb53d4142ad2cdbe9dfdbd01cc..9d8bd034ab6b322e3d178f362e7c5e82d293dad9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_ctrl_csi" 9 "nvme_identify_ctrl_csi" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_ctrl_csi" 9 "nvme_identify_ctrl_csi" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_ctrl_csi \- I/O command set specific Identify Controller data
 .SH SYNOPSIS
index 7a8f42dc42123e002fbee6b159ca558373e6ae00..3019f2070f27b954bbad26e65e1e30081d174127 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_ctrl_list" 9 "nvme_identify_ctrl_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_ctrl_list" 9 "nvme_identify_ctrl_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_ctrl_list \- Retrieves identify controller list
 .SH SYNOPSIS
index bb6d65910ab353e8e3207453d21201ff085896ed..18ec2e999cac83e4d353bc48f033fe5a29fb90da 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_domain_list" 9 "nvme_identify_domain_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_domain_list" 9 "nvme_identify_domain_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_domain_list \- Domain list data
 .SH SYNOPSIS
index 3fa011b3aff6c58b5e00a6603a526b946dbf46b7..188dde43f355aeac8126de31ad896e33eedab408 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_endurance_group_list" 9 "nvme_identify_endurance_group_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_endurance_group_list" 9 "nvme_identify_endurance_group_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_endurance_group_list \- Endurance group list data
 .SH SYNOPSIS
index 4e3db914842db13c2a18437c269cb827061f8f95..e9d407026a26acd7425f5a95182209b63a52acdd 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_independent_identify_ns" 9 "nvme_identify_independent_identify_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_independent_identify_ns" 9 "nvme_identify_independent_identify_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_independent_identify_ns \- I/O command set independent Identify namespace data
 .SH SYNOPSIS
index edc64db23d65a91387e58280dcf88cb65ff3824e..fdbd644223a81dda4f615113937723d648c1035d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_iocs" 9 "nvme_identify_iocs" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_iocs" 9 "nvme_identify_iocs" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_iocs \- I/O command set data structure
 .SH SYNOPSIS
index ac16543fdd664c48199b25d942a4efe32820c5d4..6bddd4c936b5b7fb92fb81346f396998a4949d1b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_iocs_ns_csi_user_data_format" 9 "nvme_identify_iocs_ns_csi_user_data_format" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_iocs_ns_csi_user_data_format" 9 "nvme_identify_iocs_ns_csi_user_data_format" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_iocs_ns_csi_user_data_format \- Identify I/O command set namespace data structure
 .SH SYNOPSIS
index 39fd911bb228a5358b82edeb2312e41127f3c133..fa03c1d2ccab04200d2d1d80cbdac4ebf2b30e9d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_ns" 9 "nvme_identify_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_ns" 9 "nvme_identify_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_ns \- Retrieves nvme identify namespace
 .SH SYNOPSIS
index e41e276f4326bcaa8f713a89e19a3ac53c5ebcdf..0d6437e476e7586ad5f7c4d3b46ced82ca771db6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_ns_csi" 9 "nvme_identify_ns_csi" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_ns_csi" 9 "nvme_identify_ns_csi" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_ns_csi \- I/O command set specific identify namespace data
 .SH SYNOPSIS
index a8d85aeb3d1461483530a8d271cdf7d060d554fb..f34c5f8b9bc4820db8c68bf30d855a76dac3e204 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_ns_csi_user_data_format" 9 "nvme_identify_ns_csi_user_data_format" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_ns_csi_user_data_format" 9 "nvme_identify_ns_csi_user_data_format" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_ns_csi_user_data_format \- Identify namespace user data format
 .SH SYNOPSIS
index ac1a1f6cd8bc8f876ed8e203d074d835de7f0b50..5f00ec1133f75df9171a42a76f89e36dab403324 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_ns_descs" 9 "nvme_identify_ns_descs" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_ns_descs" 9 "nvme_identify_ns_descs" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_ns_descs \- Retrieves namespace descriptor list
 .SH SYNOPSIS
index 01efee4cb2458aa455545f921e106c747667bbdc..536138687e311aff097e3c1b068de889bd754b36 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_ns_granularity" 9 "nvme_identify_ns_granularity" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_ns_granularity" 9 "nvme_identify_ns_granularity" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_ns_granularity \- Retrieves namespace granularity identification
 .SH SYNOPSIS
index dc38f359e71ec500a33f8d895a3af4b46246c9b5..7eb5d078f1901cdca78dc94df813f2d88f40e65c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_nsid_ctrl_list" 9 "nvme_identify_nsid_ctrl_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_nsid_ctrl_list" 9 "nvme_identify_nsid_ctrl_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_nsid_ctrl_list \- Retrieves controller list attached to an nsid
 .SH SYNOPSIS
index e653bd8f54bf9774660fadf8efe5c5a631f9cc6f..139a20eb0a71ad04c0592a09e554a9d11b325927 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_nvmset_list" 9 "nvme_identify_nvmset_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_nvmset_list" 9 "nvme_identify_nvmset_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_nvmset_list \- Retrieves NVM Set List
 .SH SYNOPSIS
index 96ad2d7b940e9a5249f60b8e07ef7127e4783b2a..6b725cbbfb3e90a116e6b20b81c18602211bfa16 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_primary_ctrl" 9 "nvme_identify_primary_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_primary_ctrl" 9 "nvme_identify_primary_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_primary_ctrl \- Retrieve NVMe Primary Controller identification
 .SH SYNOPSIS
index 1bc358bb943d732fea484fdd99f79388374682be..354f1f03ce6d65c32bf3b4c99cb07b8722749527 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_secondary_ctrl_list" 9 "nvme_identify_secondary_ctrl_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_secondary_ctrl_list" 9 "nvme_identify_secondary_ctrl_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_secondary_ctrl_list \- Retrieves secondary controller list
 .SH SYNOPSIS
index d7a23c1a0555bd7591e0b11482a1f39cbf3c8e26..ff81c15b5fbb382a7c62ef2c6b86811cb5b9ecfc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_identify_uuid" 9 "nvme_identify_uuid" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_identify_uuid" 9 "nvme_identify_uuid" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_identify_uuid \- Retrieves device's UUIDs
 .SH SYNOPSIS
index cc68ce890053da746d924ea0cd122d35d637f5e6..7a3e7867c7dfe41f3bea06acdda82e798a7ab780 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_init_copy_range" 9 "nvme_init_copy_range" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_init_copy_range" 9 "nvme_init_copy_range" "October 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_copy_range_f1.2 b/doc/man/nvme_init_copy_range_f1.2
new file mode 100644 (file)
index 0000000..2f2f3ad
--- /dev/null
@@ -0,0 +1,27 @@
+.TH "nvme_init_copy_range_f1" 9 "nvme_init_copy_range_f1" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_init_copy_range_f1 \- Constructs a copy range f1 structure
+.SH SYNOPSIS
+.B "void" nvme_init_copy_range_f1
+.BI "(struct nvme_copy_range_f1 *copy "  ","
+.BI "__u16 *nlbs "  ","
+.BI "__u64 *slbas "  ","
+.BI "__u64 *eilbrts "  ","
+.BI "__u32 *elbatms "  ","
+.BI "__u32 *elbats "  ","
+.BI "__u16 nr "  ");"
+.SH ARGUMENTS
+.IP "copy" 12
+Copy range array
+.IP "nlbs" 12
+Number of logical blocks
+.IP "slbas" 12
+Starting LBA
+.IP "eilbrts" 12
+Expected initial logical block reference tag
+.IP "elbatms" 12
+Expected logical block application tag mask
+.IP "elbats" 12
+Expected logical block application tag
+.IP "nr" 12
+Number of descriptors to construct
index c3d1a19e557fccd13f07d51f1114323f7c16ab60..941281cc571e0a9f7d1b819f8bb4100ed446880c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_init_ctrl" 9 "nvme_init_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_init_ctrl" 9 "nvme_init_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_init_ctrl \- Initialize nvme_ctrl_t object for an existing controller.
 .SH SYNOPSIS
index 9dd3b920fcccd15ae2e88861b42ad050efaa4bad..44cf66c89c8476fb786b3ca59c91c6a40c11f995 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_init_ctrl_list" 9 "nvme_init_ctrl_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_init_ctrl_list" 9 "nvme_init_ctrl_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_init_ctrl_list \- Initialize an nvme_ctrl_list structure from an array.
 .SH SYNOPSIS
index 57bdb3d6b0c60716d184e68c969753162144fc12..b7d7b69e1ff76e2fcd1dd6bf6e319f229de85bc9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_init_dsm_range" 9 "nvme_init_dsm_range" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_init_dsm_range" 9 "nvme_init_dsm_range" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_init_dsm_range \- Constructs a data set range structure
 .SH SYNOPSIS
index 626c541d412ecf2b052fbf117e336d1fc03954d0..f33d25b3fb7daaf2227e2ab94eac3e7d794bd3cd 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_init_logging" 9 "nvme_init_logging" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_init_logging" 9 "nvme_init_logging" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_init_logging \- Initialize logging
 .SH SYNOPSIS
index 64c0fc7e076445427f7a76ab859ea41155b530bb..bb357b2899b082b0090b47cdb2c1d54fef750f51 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_io" 9 "nvme_io" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_io" 9 "nvme_io" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_io \- Submit an nvme user I/O command
 .SH SYNOPSIS
index 72a2074286c3d0258e74ca8a57ff0d04d65b88a6..791f45b209a1fa9a2fd4ac13a79c8f786b22575a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_io_control_flags" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_io_control_flags" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_io_control_flags \- I/O control flags
 .SH SYNOPSIS
index adeadd31da951a8b2a74e67643b51d6998585766..fdab16c429bb3e6730c1e8c45de400effe721c9c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_io_dsm_flags" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_io_dsm_flags" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_io_dsm_flags \- Dataset Management flags
 .SH SYNOPSIS
index cbdde5e494837ae135b36903abcdbfc065499588..492161f785141b26a4639fa5552c17da254cc43f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_io_opcode" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_io_opcode" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_io_opcode \- Opcodes for I/O Commands
 .SH SYNOPSIS
index 127a45b616d9689806445125cb0572bb32e4a2b0..ffb19fcb7b68b1ea7c369e93e59cd4518da021cd 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_io_passthru" 9 "nvme_io_passthru" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_io_passthru" 9 "nvme_io_passthru" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_io_passthru \- Submit an nvme io passthrough command
 .SH SYNOPSIS
diff --git a/doc/man/nvme_io_passthru64.2 b/doc/man/nvme_io_passthru64.2
new file mode 100644 (file)
index 0000000..30e0378
--- /dev/null
@@ -0,0 +1,71 @@
+.TH "nvme_io_passthru64" 9 "nvme_io_passthru64" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_io_passthru64 \- Submit an nvme io passthrough command
+.SH SYNOPSIS
+.B "int" nvme_io_passthru64
+.BI "(int fd "  ","
+.BI "__u8 opcode "  ","
+.BI "__u8 flags "  ","
+.BI "__u16 rsvd "  ","
+.BI "__u32 nsid "  ","
+.BI "__u32 cdw2 "  ","
+.BI "__u32 cdw3 "  ","
+.BI "__u32 cdw10 "  ","
+.BI "__u32 cdw11 "  ","
+.BI "__u32 cdw12 "  ","
+.BI "__u32 cdw13 "  ","
+.BI "__u32 cdw14 "  ","
+.BI "__u32 cdw15 "  ","
+.BI "__u32 data_len "  ","
+.BI "void *data "  ","
+.BI "__u32 metadata_len "  ","
+.BI "void *metadata "  ","
+.BI "__u32 timeout_ms "  ","
+.BI "__u64 *result "  ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "opcode" 12
+The nvme io command to send
+.IP "flags" 12
+NVMe command flags (not used)
+.IP "rsvd" 12
+Reserved for future use
+.IP "nsid" 12
+Namespace identifier
+.IP "cdw2" 12
+Command dword 2
+.IP "cdw3" 12
+Command dword 3
+.IP "cdw10" 12
+Command dword 10
+.IP "cdw11" 12
+Command dword 11
+.IP "cdw12" 12
+Command dword 12
+.IP "cdw13" 12
+Command dword 13
+.IP "cdw14" 12
+Command dword 14
+.IP "cdw15" 12
+Command dword 15
+.IP "data_len" 12
+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 transferred in this command
+.IP "metadata" 12
+Pointer to user address of the metadata buffer
+.IP "timeout_ms" 12
+How long the kernel waits for the command to complete
+.IP "result" 12
+Optional field to return the result from the CQE dword 0
+.SH "DESCRIPTION"
+Parameterized form of \fBnvme_submit_io_passthru64\fP. This sets up and submits
+a \fIstruct nvme_passthru_cmd64\fP.
+
+Known values for \fIopcode\fP are defined in \fIenum nvme_io_opcode\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_is_64bit_reg.2 b/doc/man/nvme_is_64bit_reg.2
new file mode 100644 (file)
index 0000000..e23f562
--- /dev/null
@@ -0,0 +1,16 @@
+.TH "nvme_is_64bit_reg" 9 "nvme_is_64bit_reg" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_is_64bit_reg \- Checks if offset of the controller register is a know 64bit value.
+.SH SYNOPSIS
+.B "bool" nvme_is_64bit_reg
+.BI "(__u32 offset "  ");"
+.SH ARGUMENTS
+.IP "offset" 12
+Offset of controller register field in bytes
+.SH "DESCRIPTION"
+This function does not care about transport so that the offset is not going
+to be checked inside of this function for the unsupported fields in a
+specific transport. For example, BPMBL(Boot Partition Memory Buffer
+Location) register is not supported by fabrics, but it can be checked here.
+.SH "RETURN"
+true if given offset is 64bit register, otherwise it returns false.
index 6e9226a11dc96298200ca716539a4fad03f34fff..6d935be08cd30b575b71128bab993da082b74372 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_lba_range_type" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_range_type" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_lba_range_type \- LBA Range Type
 .SH SYNOPSIS
index d504531a80350c0cc403dc6738f5b671ff39e7b5..f6bf43e6a0afcdd5302891821adddbdc8d504f2f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_lba_range_type_entry" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_range_type_entry" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_lba_range_type_entry \- LBA Range Type - Data Structure Entry
 .SH SYNOPSIS
index c808846194221fc830c3d0cc26cf2935d6810332..d6e02ed36f1255765e10c4884c5fc5dc02f94e47 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_lba_rd" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_rd" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_lba_rd \- LBA Range Descriptor
 .SH SYNOPSIS
index 935895b787eba99ef0500333b4d26d903c543492..629460be92768f56db0ebfb56fbf46072b5ac3c8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_lba_status" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_status" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_lba_status \- LBA Status Descriptor List
 .SH SYNOPSIS
index ca8e5fa7d1a9791be9df811b8ee38a1a4ac619e2..1f4217585b2ba53065eaff358fa53105c52be402 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_lba_status_atype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_lba_status_atype" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_lba_status_atype \- Potentially Unrecoverable LBAs
 .SH SYNOPSIS
index 3deacaa4fcea04e413ea9660493c746e5876b582..73aab2efc428dc79d6e742e9c9a1c24e18c18461 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_lba_status_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_status_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_lba_status_desc \- LBA Status Descriptor Entry
 .SH SYNOPSIS
index 42b6a16a6d9e17e86d71ad466f9250f96f1af777..c2d1e5d7fb7ed3c09706104e443a6fae10171d68 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_lba_status_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lba_status_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_lba_status_log \- LBA Status Information Log
 .SH SYNOPSIS
index c9ac6c7256b020231de3c8bcf0674ffb59c9362f..cf946ab1cf61d6d3c95c3302b1e2f26458265859 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_lbaf" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lbaf" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_lbaf \- LBA Format Data Structure
 .SH SYNOPSIS
index 1c8eb233aa64310fd7bd145963c3bb351165e260..3d13eeab67d24485093cc4458dcee9c00ae6d8fa 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_lbaf_rp" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_lbaf_rp" "October 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
index 5293177b12946f8bd08700ee40d88b5b710954d0..32a6296fa2e5686880ddac08f7709c8f5a6b5026 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_lbart" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_lbart" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_lbart \- LBA Range Type - Data Structure Entry
 .SH SYNOPSIS
index 02e95851546a54c52bbcefcd0d05b163d8f66bb3..dc8043ea347b983c146d5401b011b60f71e2d101 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_lbas_ns_element" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_lbas_ns_element" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_lbas_ns_element \- LBA Status Log Namespace Element
 .SH SYNOPSIS
index 9712d48945ef961cd2cd33dd9eb5f66cf85e1497..775bd6b73845393c809aabf85409a4d3a8171edc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_lockdown" 9 "nvme_lockdown" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_lockdown" 9 "nvme_lockdown" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_lockdown \- Issue lockdown command
 .SH SYNOPSIS
index 1de2b0f4e798c2ab1f1b6e6958a749b96fb3c99b..3e1df4a15f9c21725821330c79f2a8485a670261 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_log_ana_lsp" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_log_ana_lsp" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_log_ana_lsp \- Asymmetric Namespace Access - Return Groups Only
 .SH SYNOPSIS
index 2db83fad66764f53bfa0512ba623a3cb76f05f69..0d400ea58840ab693928e9d5cbbf490a3b934bf3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_lookup_ctrl" 9 "nvme_lookup_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_lookup_ctrl" 9 "nvme_lookup_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_lookup_ctrl \- Lookup nvme_ctrl_t object
 .SH SYNOPSIS
index 6aec444c13f9dd23b44acc652408773de957372b..47b6239e5e536f4ca6bba94dda7b8370319526d2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_lookup_host" 9 "nvme_lookup_host" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_lookup_host" 9 "nvme_lookup_host" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_lookup_host \- Lookup nvme_host_t object
 .SH SYNOPSIS
index 1cf646428dbd4783d7520b5e276fad780b0635fc..4adc5cb17842b4fa402535bef031752e28dc01b6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_lookup_subsystem" 9 "nvme_lookup_subsystem" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_lookup_subsystem" 9 "nvme_lookup_subsystem" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_lookup_subsystem \- Lookup nvme_subsystem_t object
 .SH SYNOPSIS
index 83f9a837db1e4f177ce21dce131d97be020ec2a4..e39bb39ba7cecca173bb92a3e1987c03f90a177d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_media_unit_config_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_media_unit_config_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_media_unit_config_desc \- Media Unit Configuration Descriptor
 .SH SYNOPSIS
index dfc216ea5f690d476a6fe7edf8fa30a52a239b53..9f381b861a0bdd5bf22319265aed6488592fe2c3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_media_unit_stat_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_media_unit_stat_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_media_unit_stat_desc \- Media Unit Status Descriptor
 .SH SYNOPSIS
index c20f44485035b83cb35615c57774f7ece834168a..f23ea35758df98d2fd8b8c2bf7f36c5ad6cd3053 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_media_unit_stat_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_media_unit_stat_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_media_unit_stat_log \- Media Unit Status
 .SH SYNOPSIS
index 5da55c426f51a03b36121d64418fb70cf10f4f96..62356e499a5d98ce29deaec9c250cbe9e8ba9ac7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_metadata_element_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_metadata_element_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_metadata_element_desc \- Metadata Element Descriptor
 .SH SYNOPSIS
diff --git a/doc/man/nvme_mi_admin_format_nvm.2 b/doc/man/nvme_mi_admin_format_nvm.2
new file mode 100644 (file)
index 0000000..95550ee
--- /dev/null
@@ -0,0 +1,18 @@
+.TH "nvme_mi_admin_format_nvm" 9 "nvme_mi_admin_format_nvm" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_format_nvm \- Format NVMe namespace
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_format_nvm
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "struct nvme_format_nvm_args *args "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to send command to
+.IP "args" 12
+Format NVM command arguments
+.SH "DESCRIPTION"
+Perform a low-level format to set the LBA data & metadata size. May destroy
+data & metadata on the specified namespaces
+.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_mi_admin_fw_commit.2 b/doc/man/nvme_mi_admin_fw_commit.2
new file mode 100644 (file)
index 0000000..d7ac6ac
--- /dev/null
@@ -0,0 +1,16 @@
+.TH "nvme_mi_admin_fw_commit" 9 "nvme_mi_admin_fw_commit" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_fw_commit \- Commit firmware using the specified action
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_fw_commit
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "struct nvme_fw_commit_args *args "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to send firmware data to
+.IP "args" 12
+\fIstruct nvme_fw_download_args\fP argument structure
+.SH "DESCRIPTION"
+The Firmware Commit command modifies the firmware image or Boot Partitions.
+.SH "RETURN"
+0 on success, non-zero on failure
diff --git a/doc/man/nvme_mi_admin_fw_download.2 b/doc/man/nvme_mi_admin_fw_download.2
new file mode 100644 (file)
index 0000000..9faf329
--- /dev/null
@@ -0,0 +1,27 @@
+.TH "nvme_mi_admin_fw_download" 9 "nvme_mi_admin_fw_download" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_fw_download \- Download part or all of a firmware image to the controller
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_fw_download
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "struct nvme_fw_download_args *args "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to send firmware data to
+.IP "args" 12
+\fIstruct nvme_fw_download_args\fP argument structure
+.SH "DESCRIPTION"
+The Firmware Image Download command downloads all or a portion of an image
+for a future update to the controller. The Firmware Image Download command
+downloads a new image (in whole or in part) to the controller.
+
+The image may be constructed of multiple pieces that are individually
+downloaded with separate Firmware Image Download commands. Each Firmware
+Image Download command includes a Dword Offset and Number of Dwords that
+specify a dword range.
+
+The new firmware image is not activated as part of the Firmware Image
+Download command. Use the \fBnvme_mi_admin_fw_commit\fP to activate a newly
+downloaded image.
+.SH "RETURN"
+0 on success, non-zero on failure
diff --git a/doc/man/nvme_mi_admin_get_features_data.2 b/doc/man/nvme_mi_admin_get_features_data.2
new file mode 100644 (file)
index 0000000..4b57744
--- /dev/null
@@ -0,0 +1,30 @@
+.TH "nvme_mi_admin_get_features_data" 9 "nvme_mi_admin_get_features_data" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_features_data \- Helper function for &nvme_mi_admin_get_features()
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_features_data
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "enum nvme_features_id fid "  ","
+.BI "__u32 nsid "  ","
+.BI "__u32 data_len "  ","
+.BI "void *data "  ","
+.BI "__u32 *result "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to send command to
+.IP "fid" 12
+Feature identifier
+.IP "nsid" 12
+Namespace ID, if applicable for \fIfid\fP
+.IP "data_len" 12
+Length of feature data, if applicable for \fIfid\fP, in bytes
+.IP "data" 12
+User address of feature data, if applicable
+.IP "result" 12
+The command completion result from CQE dword0
+.SH "DESCRIPTION"
+Helper for optionally features that optionally return data, using the
+SEL_CURRENT selector value.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index 17271246311c327b237b9ce8952f043a6619f5ec..f52c6689c6b0708bce5d1c2cb403f3112627b043 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_admin_get_log" 9 "nvme_mi_admin_get_log" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_get_log" 9 "nvme_mi_admin_get_log" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_admin_get_log \- Retrieve log page data from controller
 .SH SYNOPSIS
@@ -21,4 +21,5 @@ to fit within MI message-size limits.
 
 See: \fIstruct nvme_get_log_args\fP
 .SH "RETURN"
-0 on success, non-zero on failure
+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_mi_admin_get_log_ana.2 b/doc/man/nvme_mi_admin_get_log_ana.2
new file mode 100644 (file)
index 0000000..b5bd512
--- /dev/null
@@ -0,0 +1,33 @@
+.TH "nvme_mi_admin_get_log_ana" 9 "nvme_mi_admin_get_log_ana" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_ana \- Retrieve Asymmetric Namespace Access log page
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_ana
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "enum nvme_log_ana_lsp lsp "  ","
+.BI "bool rae "  ","
+.BI "__u64 offset "  ","
+.BI "__u32 len "  ","
+.BI "void *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "lsp" 12
+Log specific, see \fIenum nvme_get_log_ana_lsp\fP
+.IP "rae" 12
+Retain asynchronous events
+.IP "offset" 12
+Offset to the start of the log page
+.IP "len" 12
+The allocated length of the log page
+.IP "log" 12
+User address to store the ana log
+.SH "DESCRIPTION"
+This log consists of a header describing the log and descriptors containing
+the asymmetric namespace access information for ANA Groups that contain
+namespaces that are attached to the controller processing the command.
+
+See \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_mi_admin_get_log_ana_groups.2 b/doc/man/nvme_mi_admin_get_log_ana_groups.2
new file mode 100644 (file)
index 0000000..2aae5b2
--- /dev/null
@@ -0,0 +1,23 @@
+.TH "nvme_mi_admin_get_log_ana_groups" 9 "nvme_mi_admin_get_log_ana_groups" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_ana_groups \- Retrieve Asymmetric Namespace Access groups only log page
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_ana_groups
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "__u32 len "  ","
+.BI "struct nvme_ana_group_desc *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "len" 12
+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 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_mi_admin_get_log_boot_partition.2 b/doc/man/nvme_mi_admin_get_log_boot_partition.2
new file mode 100644 (file)
index 0000000..8c4238f
--- /dev/null
@@ -0,0 +1,25 @@
+.TH "nvme_mi_admin_get_log_boot_partition" 9 "nvme_mi_admin_get_log_boot_partition" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_boot_partition \- Retrieve Boot Partition
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_boot_partition
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "__u8 lsp "  ","
+.BI "__u32 len "  ","
+.BI "struct nvme_boot_partition *part "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "lsp" 12
+The log specified field of LID
+.IP "len" 12
+The allocated size, minimum
+struct nvme_boot_partition
+.IP "part" 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_mi_admin_get_log_changed_ns_list.2 b/doc/man/nvme_mi_admin_get_log_changed_ns_list.2
new file mode 100644 (file)
index 0000000..a95b090
--- /dev/null
@@ -0,0 +1,22 @@
+.TH "nvme_mi_admin_get_log_changed_ns_list" 9 "nvme_mi_admin_get_log_changed_ns_list" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_changed_ns_list \- Retrieve namespace changed list
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_changed_ns_list
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "struct nvme_ns_list *ns_log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "ns_log" 12
+User address to store the log page
+.SH "DESCRIPTION"
+This log page describes namespaces attached to this controller that have
+changed since the last time the namespace was identified, been added, or
+deleted.
+.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_mi_admin_get_log_cmd_effects.2 b/doc/man/nvme_mi_admin_get_log_cmd_effects.2
new file mode 100644 (file)
index 0000000..1aa24f6
--- /dev/null
@@ -0,0 +1,21 @@
+.TH "nvme_mi_admin_get_log_cmd_effects" 9 "nvme_mi_admin_get_log_cmd_effects" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_cmd_effects \- Retrieve nvme command effects log
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_cmd_effects
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "enum nvme_csi csi "  ","
+.BI "struct nvme_cmd_effects_log *effects_log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "csi" 12
+Command Set Identifier
+.IP "effects_log" 12
+User address to store the effects log
+.SH "DESCRIPTION"
+This log page describes the commands that the controller supports and the
+effects of those commands on the state of the NVM subsystem.
+.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_mi_admin_get_log_create_telemetry_host.2 b/doc/man/nvme_mi_admin_get_log_create_telemetry_host.2
new file mode 100644 (file)
index 0000000..47cfccc
--- /dev/null
@@ -0,0 +1,15 @@
+.TH "nvme_mi_admin_get_log_create_telemetry_host" 9 "nvme_mi_admin_get_log_create_telemetry_host" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_create_telemetry_host \- Create host telemetry log
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_create_telemetry_host
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "struct nvme_telemetry_log *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.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_mi_admin_get_log_device_self_test.2 b/doc/man/nvme_mi_admin_get_log_device_self_test.2
new file mode 100644 (file)
index 0000000..d05eb67
--- /dev/null
@@ -0,0 +1,19 @@
+.TH "nvme_mi_admin_get_log_device_self_test" 9 "nvme_mi_admin_get_log_device_self_test" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_device_self_test \- Retrieve the device self test log
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_device_self_test
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "struct nvme_self_test_log *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "log" 12
+Userspace address of the log payload
+.SH "DESCRIPTION"
+The log page indicates the status of an in progress self test and the
+percent complete of that operation, and the results of the previous 20
+self-test operations.
+.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_mi_admin_get_log_discovery.2 b/doc/man/nvme_mi_admin_get_log_discovery.2
new file mode 100644 (file)
index 0000000..056bb2b
--- /dev/null
@@ -0,0 +1,27 @@
+.TH "nvme_mi_admin_get_log_discovery" 9 "nvme_mi_admin_get_log_discovery" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_discovery \- Retrieve Discovery log page
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_discovery
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "__u32 offset "  ","
+.BI "__u32 len "  ","
+.BI "void *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "offset" 12
+Offset of this log to retrieve
+.IP "len" 12
+The allocated size for this portion of the log
+.IP "log" 12
+User address to store the discovery log
+.SH "DESCRIPTION"
+Supported only by fabrics discovery controllers, returning discovery
+records.
+.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_mi_admin_get_log_endurance_group.2 b/doc/man/nvme_mi_admin_get_log_endurance_group.2
new file mode 100644 (file)
index 0000000..4b3fe59
--- /dev/null
@@ -0,0 +1,25 @@
+.TH "nvme_mi_admin_get_log_endurance_group" 9 "nvme_mi_admin_get_log_endurance_group" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_endurance_group \- Get Endurance Group log
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_endurance_group
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u16 endgid "  ","
+.BI "struct nvme_endurance_group_log *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "endgid" 12
+Starting group identifier to return in the list
+.IP "log" 12
+User address to store the endurance log
+.SH "DESCRIPTION"
+This log page indicates if an Endurance Group Event has occurred for a
+particular Endurance Group. If an Endurance Group Event has occurred, the
+details of the particular event are included in the Endurance Group
+Information log page for that Endurance Group. An asynchronous event is
+generated when an entry for an Endurance Group is newly added to this log
+page.
+.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_mi_admin_get_log_endurance_grp_evt.2 b/doc/man/nvme_mi_admin_get_log_endurance_grp_evt.2
new file mode 100644 (file)
index 0000000..c0556a1
--- /dev/null
@@ -0,0 +1,24 @@
+.TH "nvme_mi_admin_get_log_endurance_grp_evt" 9 "nvme_mi_admin_get_log_endurance_grp_evt" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_endurance_grp_evt \- Retrieve Rotational Media Information
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_endurance_grp_evt
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "__u32 offset "  ","
+.BI "__u32 len "  ","
+.BI "void *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "offset" 12
+Offset to the start of the log page
+.IP "len" 12
+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_mi_admin_get_log_error.2 b/doc/man/nvme_mi_admin_get_log_error.2
new file mode 100644 (file)
index 0000000..eac5d66
--- /dev/null
@@ -0,0 +1,25 @@
+.TH "nvme_mi_admin_get_log_error" 9 "nvme_mi_admin_get_log_error" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_error \- Retrieve nvme error log
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_error
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "unsigned int nr_entries "  ","
+.BI "bool rae "  ","
+.BI "struct nvme_error_log_page *err_log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "nr_entries" 12
+Number of error log entries allocated
+.IP "rae" 12
+Retain asynchronous events
+.IP "err_log" 12
+Array of error logs of size 'entries'
+.SH "DESCRIPTION"
+This log page describes extended error information for a command that
+completed with error, or may report an error that is not specific to a
+particular command.
+.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_mi_admin_get_log_fid_supported_effects.2 b/doc/man/nvme_mi_admin_get_log_fid_supported_effects.2
new file mode 100644 (file)
index 0000000..999c1eb
--- /dev/null
@@ -0,0 +1,18 @@
+.TH "nvme_mi_admin_get_log_fid_supported_effects" 9 "nvme_mi_admin_get_log_fid_supported_effects" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_fid_supported_effects \- Retrieve Feature Identifiers Supported and Effects
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_fid_supported_effects
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "struct nvme_fid_supported_effects_log *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "log" 12
+FID Supported and Effects data 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_mi_admin_get_log_fw_slot.2 b/doc/man/nvme_mi_admin_get_log_fw_slot.2
new file mode 100644 (file)
index 0000000..d4e3952
--- /dev/null
@@ -0,0 +1,22 @@
+.TH "nvme_mi_admin_get_log_fw_slot" 9 "nvme_mi_admin_get_log_fw_slot" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_fw_slot \- Retrieves the controller firmware log
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_fw_slot
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "struct nvme_firmware_slot *fw_log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "fw_log" 12
+User address to store the log page
+.SH "DESCRIPTION"
+This log page describes the firmware revision stored in each firmware slot
+supported. The firmware revision is indicated as an ASCII string. The log
+page also indicates the active slot number.
+.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_mi_admin_get_log_lba_status.2 b/doc/man/nvme_mi_admin_get_log_lba_status.2
new file mode 100644 (file)
index 0000000..d2bd99e
--- /dev/null
@@ -0,0 +1,24 @@
+.TH "nvme_mi_admin_get_log_lba_status" 9 "nvme_mi_admin_get_log_lba_status" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_lba_status \- Retrieve LBA Status
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_lba_status
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "__u64 offset "  ","
+.BI "__u32 len "  ","
+.BI "void *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "offset" 12
+Offset to the start of the log page
+.IP "len" 12
+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_mi_admin_get_log_media_unit_stat.2 b/doc/man/nvme_mi_admin_get_log_media_unit_stat.2
new file mode 100644 (file)
index 0000000..05706f7
--- /dev/null
@@ -0,0 +1,18 @@
+.TH "nvme_mi_admin_get_log_media_unit_stat" 9 "nvme_mi_admin_get_log_media_unit_stat" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_media_unit_stat \- Retrieve Media Unit Status
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_media_unit_stat
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u16 domid "  ","
+.BI "struct nvme_media_unit_stat_log *mus "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "domid" 12
+Domain Identifier selection, if supported
+.IP "mus" 12
+User address to store the Media Unit statistics 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_mi_admin_get_log_mi_cmd_supported_effects.2 b/doc/man/nvme_mi_admin_get_log_mi_cmd_supported_effects.2
new file mode 100644 (file)
index 0000000..11df378
--- /dev/null
@@ -0,0 +1,18 @@
+.TH "nvme_mi_admin_get_log_mi_cmd_supported_effects" 9 "nvme_mi_admin_get_log_mi_cmd_supported_effects" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_mi_cmd_supported_effects \- displays the MI Commands Supported by the controller
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_mi_cmd_supported_effects
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "struct nvme_mi_cmd_supported_effects_log *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "log" 12
+MI Command Supported and Effects data 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_mi_admin_get_log_persistent_event.2 b/doc/man/nvme_mi_admin_get_log_persistent_event.2
new file mode 100644 (file)
index 0000000..aa53c90
--- /dev/null
@@ -0,0 +1,21 @@
+.TH "nvme_mi_admin_get_log_persistent_event" 9 "nvme_mi_admin_get_log_persistent_event" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_persistent_event \- Retrieve Persistent Event Log
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_persistent_event
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "enum nvme_pevent_log_action action "  ","
+.BI "__u32 size "  ","
+.BI "void *pevent_log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "action" 12
+Action the controller should take during processing this command
+.IP "size" 12
+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_mi_admin_get_log_predictable_lat_event.2 b/doc/man/nvme_mi_admin_get_log_predictable_lat_event.2
new file mode 100644 (file)
index 0000000..c2e9f56
--- /dev/null
@@ -0,0 +1,24 @@
+.TH "nvme_mi_admin_get_log_predictable_lat_event" 9 "nvme_mi_admin_get_log_predictable_lat_event" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_predictable_lat_event \- Retrieve Predictable Latency Event Aggregate Log Page
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_predictable_lat_event
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "__u32 offset "  ","
+.BI "__u32 len "  ","
+.BI "void *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "offset" 12
+Offset into the predictable latency event
+.IP "len" 12
+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_mi_admin_get_log_predictable_lat_nvmset.2 b/doc/man/nvme_mi_admin_get_log_predictable_lat_nvmset.2
new file mode 100644 (file)
index 0000000..5315b41
--- /dev/null
@@ -0,0 +1,18 @@
+.TH "nvme_mi_admin_get_log_predictable_lat_nvmset" 9 "nvme_mi_admin_get_log_predictable_lat_nvmset" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_predictable_lat_nvmset \- Predictable Latency Per NVM Set
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_predictable_lat_nvmset
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u16 nvmsetid "  ","
+.BI "struct nvme_nvmset_predictable_lat_log *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "nvmsetid" 12
+NVM set id
+.IP "log" 12
+User address to store the predictable latency 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_mi_admin_get_log_reservation.2 b/doc/man/nvme_mi_admin_get_log_reservation.2
new file mode 100644 (file)
index 0000000..44c4ef2
--- /dev/null
@@ -0,0 +1,18 @@
+.TH "nvme_mi_admin_get_log_reservation" 9 "nvme_mi_admin_get_log_reservation" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_reservation \- Retrieve Reservation Notification
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_reservation
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "struct nvme_resv_notification_log *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+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_mi_admin_get_log_sanitize.2 b/doc/man/nvme_mi_admin_get_log_sanitize.2
new file mode 100644 (file)
index 0000000..b457c53
--- /dev/null
@@ -0,0 +1,21 @@
+.TH "nvme_mi_admin_get_log_sanitize" 9 "nvme_mi_admin_get_log_sanitize" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_sanitize \- Retrieve Sanitize Status
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_sanitize
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "struct nvme_sanitize_log_page *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "log" 12
+User address to store the sanitize log
+.SH "DESCRIPTION"
+The Sanitize Status log page reports sanitize operation time estimates and
+information about the most recent sanitize operation.
+.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_mi_admin_get_log_simple.2 b/doc/man/nvme_mi_admin_get_log_simple.2
new file mode 100644 (file)
index 0000000..1db47a6
--- /dev/null
@@ -0,0 +1,24 @@
+.TH "nvme_mi_admin_get_log_simple" 9 "nvme_mi_admin_get_log_simple" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_simple \- Helper for Get Log Page functions with no NSID or RAE requirements
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_simple
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "enum nvme_cmd_get_log_lid lid "  ","
+.BI "__u32 len "  ","
+.BI "void *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "lid" 12
+Log identifier
+.IP "len" 12
+length of log buffer
+.IP "log" 12
+pointer for resulting log data
+.SH "DESCRIPTION"
+Performs a Get Log Page Admin command for a specific log ID \fIlid\fP, using
+NVME_NSID_ALL for the namespace identifier, and rae set to false.
+.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_mi_admin_get_log_smart.2 b/doc/man/nvme_mi_admin_get_log_smart.2
new file mode 100644 (file)
index 0000000..4110313
--- /dev/null
@@ -0,0 +1,28 @@
+.TH "nvme_mi_admin_get_log_smart" 9 "nvme_mi_admin_get_log_smart" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_smart \- Retrieve nvme smart log
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_smart
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "bool rae "  ","
+.BI "struct nvme_smart_log *smart_log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "nsid" 12
+Optional namespace identifier
+.IP "rae" 12
+Retain asynchronous events
+.IP "smart_log" 12
+User address to store the smart log
+.SH "DESCRIPTION"
+This log page provides SMART and general health information. The information
+provided is over the life of the controller and is retained across power
+cycles. To request the controller log page, the namespace identifier
+specified is FFFFFFFFh. The controller may also support requesting the log
+page on a per namespace basis, as indicated by bit 0 of the LPA field in the
+Identify Controller data structure.
+.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_mi_admin_get_log_support_cap_config_list.2 b/doc/man/nvme_mi_admin_get_log_support_cap_config_list.2
new file mode 100644 (file)
index 0000000..9effb5e
--- /dev/null
@@ -0,0 +1,18 @@
+.TH "nvme_mi_admin_get_log_support_cap_config_list" 9 "nvme_mi_admin_get_log_support_cap_config_list" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_support_cap_config_list \- Retrieve Supported Capacity Configuration List
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_support_cap_config_list
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u16 domid "  ","
+.BI "struct nvme_supported_cap_config_list_log *cap "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "domid" 12
+Domain Identifier selection, if supported
+.IP "cap" 12
+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_mi_admin_get_log_supported_log_pages.2 b/doc/man/nvme_mi_admin_get_log_supported_log_pages.2
new file mode 100644 (file)
index 0000000..0912736
--- /dev/null
@@ -0,0 +1,18 @@
+.TH "nvme_mi_admin_get_log_supported_log_pages" 9 "nvme_mi_admin_get_log_supported_log_pages" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_supported_log_pages \- Retrieve nmve supported log pages
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_supported_log_pages
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "struct nvme_supported_log_pages *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "log" 12
+Array of LID supported and Effects data structures
+.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_mi_admin_get_log_telemetry_ctrl.2 b/doc/man/nvme_mi_admin_get_log_telemetry_ctrl.2
new file mode 100644 (file)
index 0000000..7478fd3
--- /dev/null
@@ -0,0 +1,27 @@
+.TH "nvme_mi_admin_get_log_telemetry_ctrl" 9 "nvme_mi_admin_get_log_telemetry_ctrl" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_telemetry_ctrl \- Get Telemetry Controller-Initiated log page
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_telemetry_ctrl
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "__u64 offset "  ","
+.BI "__u32 len "  ","
+.BI "void *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain asynchronous events
+.IP "offset" 12
+Offset into the telemetry data
+.IP "len" 12
+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_mi_admin_get_log_telemetry_host.2 b/doc/man/nvme_mi_admin_get_log_telemetry_host.2
new file mode 100644 (file)
index 0000000..eb64be4
--- /dev/null
@@ -0,0 +1,24 @@
+.TH "nvme_mi_admin_get_log_telemetry_host" 9 "nvme_mi_admin_get_log_telemetry_host" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_telemetry_host \- Get Telemetry Host-Initiated log page
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_telemetry_host
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u64 offset "  ","
+.BI "__u32 len "  ","
+.BI "void *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "offset" 12
+Offset into the telemetry data
+.IP "len" 12
+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 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
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
diff --git a/doc/man/nvme_mi_admin_get_log_zns_changed_zones.2 b/doc/man/nvme_mi_admin_get_log_zns_changed_zones.2
new file mode 100644 (file)
index 0000000..9b2b78a
--- /dev/null
@@ -0,0 +1,23 @@
+.TH "nvme_mi_admin_get_log_zns_changed_zones" 9 "nvme_mi_admin_get_log_zns_changed_zones" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_log_zns_changed_zones \- Retrieve list of zones that have changed
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_log_zns_changed_zones
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "bool rae "  ","
+.BI "struct nvme_zns_changed_zone_log *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "nsid" 12
+Namespace ID
+.IP "rae" 12
+Retain asynchronous events
+.IP "log" 12
+User address to store the changed zone log
+.SH "DESCRIPTION"
+The list of zones that have changed state due to an exceptional event.
+.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_mi_admin_get_nsid_log.2 b/doc/man/nvme_mi_admin_get_nsid_log.2
new file mode 100644 (file)
index 0000000..6976fe4
--- /dev/null
@@ -0,0 +1,32 @@
+.TH "nvme_mi_admin_get_nsid_log" 9 "nvme_mi_admin_get_nsid_log" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_get_nsid_log \- Helper for Get Log Page functions
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_get_nsid_log
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "bool rae "  ","
+.BI "enum nvme_cmd_get_log_lid lid "  ","
+.BI "__u32 nsid "  ","
+.BI "__u32 len "  ","
+.BI "void *log "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to query
+.IP "rae" 12
+Retain Asynchronous Events
+.IP "lid" 12
+Log identifier
+.IP "nsid" 12
+Namespace ID
+.IP "len" 12
+length of log buffer
+.IP "log" 12
+pointer for resulting log data
+.SH "DESCRIPTION"
+Performs a Get Log Page Admin command for a specific log ID \fIlid\fP and
+namespace ID \fInsid\fP. Log data is expected to be \fIlen\fP bytes, and is stored
+in \fIlog\fP on success. The \fIrae\fP flag is passed as-is to the Get Log Page
+command, and is specific to the Log Page requested.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index 1d95814b932a11406b79a81f623d51c9f3448d99..2080bd7720801c15d738ae61da334b94e41a51e4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_admin_identify" 9 "nvme_mi_admin_identify" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify" 9 "nvme_mi_admin_identify" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_admin_identify \- Perform an Admin identify command.
 .SH SYNOPSIS
@@ -20,4 +20,5 @@ 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
+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_mi_admin_identify_active_ns_list.2 b/doc/man/nvme_mi_admin_identify_active_ns_list.2
new file mode 100644 (file)
index 0000000..bfd7a90
--- /dev/null
@@ -0,0 +1,28 @@
+.TH "nvme_mi_admin_identify_active_ns_list" 9 "nvme_mi_admin_identify_active_ns_list" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_identify_active_ns_list \- Perform an Admin identify for an active namespace list
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_identify_active_ns_list
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "struct nvme_ns_list *list "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to process identify command
+.IP "nsid" 12
+Namespace ID to specify list start
+.IP "list" 12
+List data to populate
+.SH "DESCRIPTION"
+Perform an Identify command, for the active namespace list starting with
+IDs greater than or equal to \fInsid\fP. Specify \fINVME_NSID_NONE\fP for the start
+of the list.
+
+Will return an error if the length of the response data (from the
+controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP, so \fIlist\fP will be
+be fully populated on success.
+
+See: \fIstruct nvme_ns_list\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_mi_admin_identify_allocated_ns.2 b/doc/man/nvme_mi_admin_identify_allocated_ns.2
new file mode 100644 (file)
index 0000000..b588c34
--- /dev/null
@@ -0,0 +1,21 @@
+.TH "nvme_mi_admin_identify_allocated_ns" 9 "nvme_mi_admin_identify_allocated_ns" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_identify_allocated_ns \- Perform an Admin identify command for an allocated namespace
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_identify_allocated_ns
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "struct nvme_id_ns *ns "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to process identify command
+.IP "nsid" 12
+namespace ID
+.IP "ns" 12
+Namespace identification to populate
+.SH "DESCRIPTION"
+Perform an Identify (namespace) command, setting the namespace id data
+in \fIns\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_mi_admin_identify_allocated_ns_list.2 b/doc/man/nvme_mi_admin_identify_allocated_ns_list.2
new file mode 100644 (file)
index 0000000..d29553a
--- /dev/null
@@ -0,0 +1,28 @@
+.TH "nvme_mi_admin_identify_allocated_ns_list" 9 "nvme_mi_admin_identify_allocated_ns_list" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_identify_allocated_ns_list \- Perform an Admin identify for an allocated namespace list
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_identify_allocated_ns_list
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "struct nvme_ns_list *list "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to process identify command
+.IP "nsid" 12
+Namespace ID to specify list start
+.IP "list" 12
+List data to populate
+.SH "DESCRIPTION"
+Perform an Identify command, for the allocated namespace list starting with
+IDs greater than or equal to \fInsid\fP. Specify \fINVME_NSID_NONE\fP for the start
+of the list.
+
+Will return an error if the length of the response data (from the
+controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP, so \fIlist\fP will be
+be fully populated on success.
+
+See: \fIstruct nvme_ns_list\fP
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index 9cb882b5c0703fba16a3760d8e56721bc0811ca1..314c0471febe46216b87de68537c46f586695ca8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_admin_identify_cns_nsid" 9 "nvme_mi_admin_identify_cns_nsid" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_cns_nsid" 9 "nvme_mi_admin_identify_cns_nsid" "October 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
@@ -26,4 +26,5 @@ Stores the identify data in \fIdata\fP, which is expected to be a buffer of
 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
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index 8f82ff42487e066254b25530d0824d65265c44f9..f3ed4113af5a5901e2a7d2db4447120f116068b1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_admin_identify_ctrl" 9 "nvme_mi_admin_identify_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_ctrl" 9 "nvme_mi_admin_identify_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_admin_identify_ctrl \- Perform an Admin identify for a controller
 .SH SYNOPSIS
@@ -20,4 +20,5 @@ fully populated on success.
 
 See: \fIstruct nvme_id_ctrl\fP
 .SH "RETURN"
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index 477401ee8bdd15859ce1e22dfd3baa91f1a1e317..d223cb0f86bcece28777784dbf387d64c46e8416 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_admin_identify_ctrl_list" 9 "nvme_mi_admin_identify_ctrl_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_ctrl_list" 9 "nvme_mi_admin_identify_ctrl_list" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_admin_identify_ctrl_list \- Perform an Admin identify for a controller list.
 .SH SYNOPSIS
@@ -23,4 +23,5 @@ fully populated on success.
 
 See: \fIstruct nvme_ctrl_list\fP
 .SH "RETURN"
-0 on success, non-zero on failure
+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_mi_admin_identify_ns.2 b/doc/man/nvme_mi_admin_identify_ns.2
new file mode 100644 (file)
index 0000000..233be5b
--- /dev/null
@@ -0,0 +1,21 @@
+.TH "nvme_mi_admin_identify_ns" 9 "nvme_mi_admin_identify_ns" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_identify_ns \- Perform an Admin identify command for a namespace
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_identify_ns
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "struct nvme_id_ns *ns "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to process identify command
+.IP "nsid" 12
+namespace ID
+.IP "ns" 12
+Namespace identification to populate
+.SH "DESCRIPTION"
+Perform an Identify (namespace) command, setting the namespace id data
+in \fIns\fP. The namespace is expected to active and allocated.
+.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_mi_admin_identify_ns_descs.2 b/doc/man/nvme_mi_admin_identify_ns_descs.2
new file mode 100644 (file)
index 0000000..b937a84
--- /dev/null
@@ -0,0 +1,21 @@
+.TH "nvme_mi_admin_identify_ns_descs" 9 "nvme_mi_admin_identify_ns_descs" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_identify_ns_descs \- Perform an Admin identify Namespace Identification Descriptor list command for a namespace
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_identify_ns_descs
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "struct nvme_ns_id_desc *descs "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to process identify command
+.IP "nsid" 12
+Namespace ID
+.IP "descs" 12
+Namespace Identification Descriptor list to populate
+.SH "DESCRIPTION"
+Perform an Identify namespace identification description list command,
+setting the namespace identification description list in \fIdescs\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_mi_admin_identify_nsid_ctrl_list.2 b/doc/man/nvme_mi_admin_identify_nsid_ctrl_list.2
new file mode 100644 (file)
index 0000000..7077442
--- /dev/null
@@ -0,0 +1,30 @@
+.TH "nvme_mi_admin_identify_nsid_ctrl_list" 9 "nvme_mi_admin_identify_nsid_ctrl_list" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_identify_nsid_ctrl_list \- Perform an Admin identify for a controller list with specific namespace ID
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_identify_nsid_ctrl_list
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "__u16 cntid "  ","
+.BI "struct nvme_ctrl_list *list "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to process identify command
+.IP "nsid" 12
+Namespace identifier
+.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 for \fInsid\fP, 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"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index 8e9f867aabcce1251c9ba7b0ed62e6747b96bb22..c2d64aeb6cf5bbd4c7807440d464ae5f0663b06c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_admin_identify_partial" 9 "nvme_mi_admin_identify_partial" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_identify_partial" 9 "nvme_mi_admin_identify_partial" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_admin_identify_partial \- Perform an Admin identify command, and retrieve partial response data.
 .SH SYNOPSIS
@@ -33,4 +33,5 @@ yet supported by libnvme-mi, please contact the maintainers.
 
 See: \fIstruct nvme_identify_args\fP
 .SH "RETURN"
-0 on success, non-zero on failure
+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_mi_admin_identify_primary_ctrl.2 b/doc/man/nvme_mi_admin_identify_primary_ctrl.2
new file mode 100644 (file)
index 0000000..4c89791
--- /dev/null
@@ -0,0 +1,26 @@
+.TH "nvme_mi_admin_identify_primary_ctrl" 9 "nvme_mi_admin_identify_primary_ctrl" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_identify_primary_ctrl \- Perform an Admin identify for primary controller capabilities data structure.
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_identify_primary_ctrl
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u16 cntid "  ","
+.BI "struct nvme_primary_ctrl_cap *cap "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to process identify command
+.IP "cntid" 12
+Controller ID to specify
+.IP "cap" 12
+Primary Controller Capabilities data structure to populate
+.SH "DESCRIPTION"
+Perform an Identify command to get the Primary Controller Capabilities data
+for the controller specified by \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 \fIcap\fP will be
+be fully populated on success.
+
+See: \fIstruct nvme_primary_ctrl_cap\fP
+.SH "RETURN"
+0 on success, non-zero on failure
diff --git a/doc/man/nvme_mi_admin_identify_secondary_ctrl_list.2 b/doc/man/nvme_mi_admin_identify_secondary_ctrl_list.2
new file mode 100644 (file)
index 0000000..9773676
--- /dev/null
@@ -0,0 +1,30 @@
+.TH "nvme_mi_admin_identify_secondary_ctrl_list" 9 "nvme_mi_admin_identify_secondary_ctrl_list" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_identify_secondary_ctrl_list \- Perform an Admin identify for a secondary controller list.
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_identify_secondary_ctrl_list
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "__u16 cntid "  ","
+.BI "struct nvme_secondary_ctrl_list *list "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to process identify command
+.IP "nsid" 12
+Namespace ID to specify list start
+.IP "cntid" 12
+Controller ID to specify list start
+.IP "list" 12
+List data to populate
+.SH "DESCRIPTION"
+Perform an Identify command, for the secondary controllers associated with
+the current primary controller. Only entries with IDs greater than or
+equal to \fIcntid\fP are returned.
+
+Will return an error if the length of the response data (from the
+controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP, so \fIlist\fP will be
+be fully populated on success.
+
+See: \fIstruct nvme_secondary_ctrl_list\fP
+.SH "RETURN"
+0 on success, non-zero on failure
diff --git a/doc/man/nvme_mi_admin_ns_attach.2 b/doc/man/nvme_mi_admin_ns_attach.2
new file mode 100644 (file)
index 0000000..19fe15a
--- /dev/null
@@ -0,0 +1,15 @@
+.TH "nvme_mi_admin_ns_attach" 9 "nvme_mi_admin_ns_attach" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_ns_attach \- Attach or detach namespace to controller(s)
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_ns_attach
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "struct nvme_ns_attach_args *args "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to send command to
+.IP "args" 12
+Namespace Attach command arguments
+.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_mi_admin_ns_attach_ctrls.2 b/doc/man/nvme_mi_admin_ns_attach_ctrls.2
new file mode 100644 (file)
index 0000000..96cd691
--- /dev/null
@@ -0,0 +1,18 @@
+.TH "nvme_mi_admin_ns_attach_ctrls" 9 "nvme_mi_admin_ns_attach_ctrls" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_ns_attach_ctrls \- Attach namespace to controllers
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_ns_attach_ctrls
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "struct nvme_ctrl_list *ctrlist "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to send command to
+.IP "nsid" 12
+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_mi_admin_ns_detach_ctrls.2 b/doc/man/nvme_mi_admin_ns_detach_ctrls.2
new file mode 100644 (file)
index 0000000..a413f9b
--- /dev/null
@@ -0,0 +1,18 @@
+.TH "nvme_mi_admin_ns_detach_ctrls" 9 "nvme_mi_admin_ns_detach_ctrls" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_ns_detach_ctrls \- Detach namespace from controllers
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_ns_detach_ctrls
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "__u32 nsid "  ","
+.BI "struct nvme_ctrl_list *ctrlist "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to send command to
+.IP "nsid" 12
+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.
index 3e6bf4aac4fd323b485a48854def8bdab251b992..97d792725e72b74f04dad6c03be7171ee199df9d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_admin_req_hdr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_admin_req_hdr" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_admin_req_hdr \- Admin command request header.
 .SH SYNOPSIS
index e8f3f2841aa5c22dcc9a1f8e3f5b55046a385844..fb26a9000bad8442a4d08e618ae61241037ae3e7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_admin_resp_hdr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_admin_resp_hdr" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_admin_resp_hdr \- Admin command response header.
 .SH SYNOPSIS
diff --git a/doc/man/nvme_mi_admin_sanitize_nvm.2 b/doc/man/nvme_mi_admin_sanitize_nvm.2
new file mode 100644 (file)
index 0000000..3f2ea2c
--- /dev/null
@@ -0,0 +1,25 @@
+.TH "nvme_mi_admin_sanitize_nvm" 9 "nvme_mi_admin_sanitize_nvm" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_admin_sanitize_nvm \- Start a subsystem Sanitize operation
+.SH SYNOPSIS
+.B "int" nvme_mi_admin_sanitize_nvm
+.BI "(nvme_mi_ctrl_t ctrl "  ","
+.BI "struct nvme_sanitize_nvm_args *args "  ");"
+.SH ARGUMENTS
+.IP "ctrl" 12
+Controller to send command to
+.IP "args" 12
+Sanitize command arguments
+.SH "DESCRIPTION"
+A sanitize operation alters all user data in the NVM subsystem such that
+recovery of any previous user data from any cache, the non-volatile media,
+or any Controller Memory Buffer is not possible.
+
+The Sanitize command starts a sanitize operation or to recover from a
+previously failed sanitize operation. The sanitize operation types that may
+be supported are Block Erase, Crypto Erase, and Overwrite. All sanitize
+operations are processed in the background, i.e., completion of the sanitize
+command does not indicate completion of the sanitize operation.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index 8fc0dc71fd6e7fc8e6e1711dcb317419f0c90532..ec3abcdb03392084873d80f2203f8ac808c0dea9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_admin_security_recv" 9 "nvme_mi_admin_security_recv" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_security_recv" 9 "nvme_mi_admin_security_recv" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_admin_security_recv \- Perform a Security Receive command on a controller.
 .SH SYNOPSIS
@@ -21,4 +21,5 @@ comply with specification limits.
 
 See: \fIstruct nvme_get_log_args\fP
 .SH "RETURN"
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index bad47f05fdf9a73414ed897b1dc1cee5bdc88d01..7aad612c8906e0df2c50ee2e0ddf235db666e4ff 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_admin_security_send" 9 "nvme_mi_admin_security_send" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_security_send" 9 "nvme_mi_admin_security_send" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_admin_security_send \- Perform a Security Send command on a controller.
 .SH SYNOPSIS
@@ -21,4 +21,5 @@ comply with specification limits.
 
 See: \fIstruct nvme_get_log_args\fP
 .SH "RETURN"
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index 3f3edbaf0951ed86aff7925145b52358b8539ce4..9cccd8bbc172505ee50e148181d72056beb8f965 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_admin_xfer" 9 "nvme_mi_admin_xfer" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_admin_xfer" 9 "nvme_mi_admin_xfer" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_admin_xfer \- Raw admin transfer interface.
 .SH SYNOPSIS
@@ -38,4 +38,5 @@ 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.
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise..
index 94d88360af2201f4266050394ba50fcf4fa17598..d51b676d811edf845347f3d8975061bdef5cd742 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_ccs" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_ccs" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_ccs \- Get State Control Primitive Success Response Fields - Control Primitive Specific Response
 .SH SYNOPSIS
index dd31f5ecebb05fd05699786a64b2060dadd77c76..99b372d65afb8c5ee1b9580bb78f57001e524616 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_close" 9 "nvme_mi_close" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_close" 9 "nvme_mi_close" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_close \- Close an endpoint connection and release resources, including controller objects.
 .SH SYNOPSIS
index 40b17ba3d49ea786a1c621545055b4331fe27bb7..0da3444f26ec4791fc2f98c67bd697febbde00fd 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_close_ctrl" 9 "nvme_mi_close_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_close_ctrl" 9 "nvme_mi_close_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_close_ctrl \- free a controller
 .SH SYNOPSIS
index 2ec09075a5188751923a52f510360da65526053a..1c92f22e935780d180adb7da16a1180e2160c2bf 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_cmd_supported_effects" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_cmd_supported_effects" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_cmd_supported_effects \- MI Command Supported and Effects Data Structure
 .SH SYNOPSIS
index c6c76fd2742a55808c839926fd84722fe8c46549..2c31034a3d5efb920ea67e44bbe5645ce272b259 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_cmd_supported_effects_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_cmd_supported_effects_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_cmd_supported_effects_log \- NVMe-MI Commands Supported and Effects Log
 .SH SYNOPSIS
index f8f46ce97c00dab3a06a95031898732c33bf72cd..e1f962396857873af2a3c7a1c52c81fecce6cede 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_config_id" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_config_id" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_config_id \- NVMe-MI Configuration identifier.
 .SH SYNOPSIS
index 19a5ca6804138fb624e1ba7d47c63d964bf3387c..f32d02aefd3b67e415de8a555c1664ce5ba30285 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_config_smbus_freq" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_config_smbus_freq" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_config_smbus_freq \- SMBus/I2C frequency values
 .SH SYNOPSIS
index 22d420e1e1447f88fd3fa90b27f90d3600720586..36af0a8f17e722689b3129499edac37b16dab86a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_create_root" 9 "nvme_mi_create_root" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_create_root" 9 "nvme_mi_create_root" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_create_root \- Create top-level MI (root) handle.
 .SH SYNOPSIS
index 32508e9df1c56178a3eacb6c9069b4d2f7fda1c5..e60ee88f690a5d83625ddfe9aec2caedcec03867 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_csts" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_csts" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_csts \- Controller Health Data Structure (CHDS) - Controller Status (CSTS)
 .SH SYNOPSIS
index db5f1e9301e36db25d391a0909dea670b29273ee..3618dee07da6c9451ddcfb1906c9e746b9be01bf 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_ctrl_health_status" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_ctrl_health_status" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_ctrl_health_status \- Controller Health Data Structure (CHDS)
 .SH SYNOPSIS
index f8bec97c09253bf49bf3fff59148db7a0d9f7b71..cfc6e6f46d9a0bdc907f37491cf3f7c08fd654e1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_cwarn" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_cwarn" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_cwarn \- Controller Health Data Structure (CHDS) - Critical Warning (CWARN)
 .SH SYNOPSIS
index 62a1010b7a701b38cd3a985907f5752771dcd30f..72433cda5cf1c2d99d246daac32ef78efa42b6c3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_dtyp" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_dtyp" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_dtyp \- Data Structure Type field.
 .SH SYNOPSIS
index ef8765398348f373777cad09462de35de3b9d264..9b63108ef5a23106dae81feb5e07407572d29094 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_elem" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_elem" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_elem \- Element Descriptor Types
 .SH SYNOPSIS
index e3b839b66c16729c62a4cc8d4398a651387c60b1..f27be6c412b09548828142d81a9d0f695b61f015 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_free_root" 9 "nvme_mi_free_root" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_free_root" 9 "nvme_mi_free_root" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_free_root \- Free root object.
 .SH SYNOPSIS
index 5f43179f50d5a855966303ce403dadcef1694796..cd555a8cf2a3768137ea60b7e42127db6a3ad2fb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_init_ctrl" 9 "nvme_mi_init_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_init_ctrl" 9 "nvme_mi_init_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_init_ctrl \- initialise a NVMe controller.
 .SH SYNOPSIS
index a3f826fb31404ceb3babaad67ba75de13355d087..0d0aa0a29b499cbc0c5e833c7b1e1617cb8a8436 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_message_type" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_message_type" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_message_type \- NVMe-MI message type field.
 .SH SYNOPSIS
index 366fcdfbd15a7e5a757207309b38ee50704ed545..85690b462aa05ed7bdeb243036729a1747697b0d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_mi_opcode" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_mi_opcode" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_mi_opcode \- Operation code for supported NVMe-MI commands.
 .SH SYNOPSIS
index 830fda19653508976e1357bc3d21a29bf0f8fd10..288b63a718b2e3d8fdb74b1d5e305f1103455f9e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_mi_read_mi_data_ctrl" 9 "nvme_mi_mi_read_mi_data_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_mi_read_mi_data_ctrl" 9 "nvme_mi_mi_read_mi_data_ctrl" "October 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
@@ -19,4 +19,5 @@ controller with ID \fIctrlid\fP.
 
 See \fIstruct nvme_mi_read_ctrl_info\fP.
 .SH "RETURN"
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise..
index 69de67fbb8a5051e4ab16ad3e341dc8f1910891d..5d88fa8bfcd06fb0eea97c9de73329fb5028e239 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_mi_read_mi_data_ctrl_list" 9 "nvme_mi_mi_read_mi_data_ctrl_list" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_mi_read_mi_data_ctrl_list" 9 "nvme_mi_mi_read_mi_data_ctrl_list" "October 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
@@ -19,4 +19,5 @@ equal to \fIstart_ctrlid\fP.
 
 See \fIstruct nvme_ctrl_list\fP.
 .SH "RETURN"
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise..
index b72b283171f0e5734868ff0e0eb40dd0886a3b15..4d56bf09d869a5cb5d4ac760516134fad62a2b6e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_mi_read_mi_data_port" 9 "nvme_mi_mi_read_mi_data_port" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_mi_read_mi_data_port" 9 "nvme_mi_mi_read_mi_data_port" "October 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
@@ -20,4 +20,5 @@ range of port IDs.
 
 See \fIstruct nvme_mi_read_port_info\fP.
 .SH "RETURN"
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise..
index 69c028e82448df6576b98971afd4e854c0f91637..685399e74897be30910426bb789146ab9aef0bca 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_mi_read_mi_data_subsys" 9 "nvme_mi_mi_read_mi_data_subsys" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_mi_read_mi_data_subsys" 9 "nvme_mi_mi_read_mi_data_subsys" "October 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
@@ -14,4 +14,5 @@ subsystem information to populate
 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.
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise..
index 422a0751725a773d2af75e632353518a0e13b38f..29cd0192191b19b34e7851b439f2b1937d980bf6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_mi_req_hdr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_mi_req_hdr" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_mi_req_hdr \- MI request message header.
 .SH SYNOPSIS
index 0b93adbfb68716fa1968753615bab38f40b5c314..c330b1b0f9a7c87e4b52df29b3c5343db9de10a1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_mi_resp_hdr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_mi_resp_hdr" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_mi_resp_hdr \- MI response message header.
 .SH SYNOPSIS
index 6730250e25690bbb181e9173181482f3bea36e05..198744f59c49285dddf3e7b4246f2beba57cb9f1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_mi_subsystem_health_status_poll" 9 "nvme_mi_mi_subsystem_health_status_poll" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_mi_subsystem_health_status_poll" 9 "nvme_mi_mi_subsystem_health_status_poll" "October 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
@@ -20,4 +20,5 @@ 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.
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise..
index dac89e7eb2594303acdfa58ccca6e8007ff7eb21..19e863bbdb41ca389e071a50b9d89a3ab4ed8f8b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_msg_hdr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_msg_hdr" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_msg_hdr \- General MI message header.
 .SH SYNOPSIS
index 6196b3d55eb052f32bc119eb5e356497ac15ee00..d0fd3322b41072a7795e271ac1b53f42f52b6cf8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_msg_resp" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_msg_resp" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_msg_resp \- Generic response type.
 .SH SYNOPSIS
index 62e101444e2db35576e5f84d26268234410b20b8..4c3e829c1fbbfd3b6a5511bc6fc77f34d9d0ae5d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_nvm_ss_health_status" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_nvm_ss_health_status" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_nvm_ss_health_status \- Subsystem Management Data Structure
 .SH SYNOPSIS
index 307b0b1032afcdc4370c1dfae83ba91419986e2c..df239fb9f011da6aada2cd9e3e239e204c89cff9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_mi_open_mctp" 9 "nvme_mi_open_mctp" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_mi_open_mctp" 9 "nvme_mi_open_mctp" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_mi_open_mctp \- Create an endpoint using a MCTP connection.
 .SH SYNOPSIS
index 2105e3d726b7abce8a2de2a04f4b416489203319..447786f2dded7ba212c55cfa7807025cb064c64d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_osc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_osc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_osc \- Optionally Supported Command Data Structure
 .SH SYNOPSIS
index e5e760a8256e4112336af98c02fbea9633f576b4..09825feaf232dcb869a7ddd3a1df8e758c19ed83 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_port_pcie" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_port_pcie" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_port_pcie \- PCIe Port Specific Data
 .SH SYNOPSIS
index f3a5319bbc9f0b50574a4254e81a0e1865b23928..c11e3dd18974eca0cb951fb3202ed3b98c4d415f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_port_smb" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_port_smb" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_port_smb \- SMBus Port Specific Data
 .SH SYNOPSIS
index 16b06d196de804484079b06d99dd4f0ccde5d236..830e7f82fe100859b68526c55307e507d42fc3e7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_read_ctrl_info" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_read_ctrl_info" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_read_ctrl_info \- Controller Information Data Structure
 .SH SYNOPSIS
index 581f8da9e07c323d9d53c847ccd4e523d8440e25..a761e7dee0309ad6d52c50287f438374e988ab72 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_read_nvm_ss_info" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_read_nvm_ss_info" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_read_nvm_ss_info \- NVM Subsystem Information Data Structure
 .SH SYNOPSIS
index 4c00a67f5b698517104cfcd2cf7111d75506fc7f..831aff747d3d8dc54c56fec748cd84bf240a6d43 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_read_port_info" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_read_port_info" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_read_port_info \- Port Information Data Structure
 .SH SYNOPSIS
index f7f6096cf92e95d53d979b57e6c8e5ed4b9cf9ba..c3fa251360d8225cc368b4f3b4613d3447aa8ab7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_read_sc_list" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_read_sc_list" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_read_sc_list \- Management Endpoint Buffer Supported Command List Data Structure
 .SH SYNOPSIS
index a46bafc0bc3cf567700addc8f6343a135034fe8c..e0b79c99c05a9fad6a03a6168cc11018b126817b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_mi_resp_status" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_mi_resp_status" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_mi_resp_status \- values for the response status field
 .SH SYNOPSIS
diff --git a/doc/man/nvme_mi_status_to_string.2 b/doc/man/nvme_mi_status_to_string.2
new file mode 100644 (file)
index 0000000..a65a85f
--- /dev/null
@@ -0,0 +1,17 @@
+.TH "nvme_mi_status_to_string" 9 "nvme_mi_status_to_string" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_mi_status_to_string \- return a string representation of the MI status.
+.SH SYNOPSIS
+.B "const char *" nvme_mi_status_to_string
+.BI "(int status "  ");"
+.SH ARGUMENTS
+.IP "status" 12
+MI response status
+.SH "DESCRIPTION"
+Gives a string description of \fIstatus\fP, as per section 4.1.2 of the NVMe-MI
+spec. The status value should be of type NVME_STATUS_MI, and extracted
+from the return value using \fBnvme_status_get_value\fP.
+
+Returned string is const, and should not be \fBfree\fPed.
+.SH "RETURN"
+A string representing the status value
index 8f65e068e4ac6c7dc5df389f1916ef292358f58d..79188a8897dee54c5c849ebebdad5030b491484d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_vpd_hdr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_hdr" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_vpd_hdr \- Vital Product Data Common Header
 .SH SYNOPSIS
index b88a43f1526b0a59a382423b3900ccba42ddac98..95195c3260e624745ad64df963fc335cf60aca03 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_vpd_mr_common" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_mr_common" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_vpd_mr_common \- NVMe MultiRecord Area
 .SH SYNOPSIS
index b9d192b934676d2a6c09de215d351051c9cd4268..76c1dda574a1ac1b5a5e39f33ee9bcad5e9c0905 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_vpd_mra" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_mra" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_vpd_mra \- NVMe MultiRecord Area
 .SH SYNOPSIS
index 0065676c7082fa398b39f73e4890531260e05e91..7d2050e6a00671bd41c98b5af25d738a466d0645 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_vpd_ppmra" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_ppmra" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_vpd_ppmra \- NVMe PCIe Port MultiRecord Area
 .SH SYNOPSIS
index c8f236b2b413eabae22cc7a0a6bbf8e5ad59a997..22524e482bed507e3735dde1750e373a299504b6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_vpd_telem" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_telem" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_vpd_telem \- Vital Product Data Element Descriptor
 .SH SYNOPSIS
index 4164d878c920758324bbf2e8b0eb45b27b6c7fd2..25aa2b6661d3dd70f9b50fd6d195339c57a9702a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_mi_vpd_tra" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_mi_vpd_tra" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_mi_vpd_tra \- Vital Product Data Topology MultiRecord
 .SH SYNOPSIS
index 862e7a15d4b456d3ced2110a7444a2e759bb65bc..f03a0d30955dbac259dc02f7dd0e40296610df3c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_namespace_attach_ctrls" 9 "nvme_namespace_attach_ctrls" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_namespace_attach_ctrls" 9 "nvme_namespace_attach_ctrls" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_namespace_attach_ctrls \- Attach namespace to controller(s)
 .SH SYNOPSIS
index 4c8a5eef3f8df868db4f30e1fe5089cbae0d3317..a98170ffebbb1b74d83bc18b611cce0e74b0a1df 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_namespace_detach_ctrls" 9 "nvme_namespace_detach_ctrls" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_namespace_detach_ctrls" 9 "nvme_namespace_detach_ctrls" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_namespace_detach_ctrls \- Detach namespace from controller(s)
 .SH SYNOPSIS
index 89fb9f298212e3478b79316c3bd8a15426474b2e..d74e8624a5de892663ce62e2c08cb0eeb59dc9db 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_namespace_filter" 9 "nvme_namespace_filter" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_namespace_filter" 9 "nvme_namespace_filter" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_namespace_filter \- Filter for namespaces
 .SH SYNOPSIS
index 0bb322df3b27ad466d1c228a43eb06e80a9871b3..f3ea1dc138da742b71a29ac44934792a60afcc0e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_namespace_first_path" 9 "nvme_namespace_first_path" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_namespace_first_path" 9 "nvme_namespace_first_path" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_namespace_first_path \- Start path iterator
 .SH SYNOPSIS
index c08b29cf540bc0931d8f6a814b12c42c7d43c3e3..a8e104a40c431c2be78874a8cb41f80ceed9c27b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_namespace_for_each_path" 9 "nvme_namespace_for_each_path" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_namespace_for_each_path" 9 "nvme_namespace_for_each_path" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_namespace_for_each_path \- Traverse paths
 .SH SYNOPSIS
index 53e0e5a95abd3e226b9092f966a137442e616dd4..a2e932c9899793937fa523a1c3911afe99a3a79b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_namespace_for_each_path_safe" 9 "nvme_namespace_for_each_path_safe" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_namespace_for_each_path_safe" 9 "nvme_namespace_for_each_path_safe" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_namespace_for_each_path_safe \- Traverse paths
 .SH SYNOPSIS
index 635ac93a28e4999f2f1a902ad4501f52e13b7ae9..66065972b871dea1d6caee375fb3ad6fd06d6cff 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_namespace_next_path" 9 "nvme_namespace_next_path" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_namespace_next_path" 9 "nvme_namespace_next_path" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_namespace_next_path \- Next path iterator
 .SH SYNOPSIS
index a0c7d16fa7abf5210d86260e78b2ce72fe2692a4..320b2c00558ec056c7bf6a02da5b245b1497ca08 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_nd_ns_fpi" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_nd_ns_fpi" "October 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
index 94ad79efb6cf2a5db6329b37e46e7f4417ec30b4..f0843782d1a2e94df7c644983c87745e1fdeac89 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_next_host" 9 "nvme_next_host" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_next_host" 9 "nvme_next_host" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_next_host \- Next host iterator
 .SH SYNOPSIS
index 89e6fa71628af13e6a731d5cb3de54b6d53346f7..55459ea61bc6c38c736f76e1a88378ab85202143 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_next_subsystem" 9 "nvme_next_subsystem" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_next_subsystem" 9 "nvme_next_subsystem" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_next_subsystem \- Next subsystem iterator
 .SH SYNOPSIS
index 9f88cdcccc586b1c3ee87a6c80eb8a384d2a64a4..fc2d0f58eaf648ed73373b2b0bd7c119d96d32c4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_attach" 9 "nvme_ns_attach" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_attach" 9 "nvme_ns_attach" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_attach \- Attach or detach namespace to controller(s)
 .SH SYNOPSIS
index 29b70f0ca349c01152fba7e20c9ffe77fe2012c7..621a4977d4162370a36b303a8e7c7cf8d0b3c64e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_attach_ctrls" 9 "nvme_ns_attach_ctrls" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_attach_ctrls" 9 "nvme_ns_attach_ctrls" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_attach_ctrls \- Attach namespace to controllers
 .SH SYNOPSIS
index 02e6d8f58bd4c1fe749701258d334839c45a6649..ec2586bbdc7a927922a5864c87c74f60449ed056 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ns_attach_sel" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ns_attach_sel" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ns_attach_sel \- Namespace Attachment - Select
 .SH SYNOPSIS
index ff0a0c0f423f48dac156cb90931918da711b3204..e6858fb482b6f981c35a15e32db4cb53a06ff9ff 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_compare" 9 "nvme_ns_compare" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_compare" 9 "nvme_ns_compare" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_compare \- Compare data on a namespace
 .SH SYNOPSIS
index 93b37f1879ca001ba0fe2ae468a834a5f6bd08f4..aa0da79a62beed65bc7368d9a8373eac9a90dd34 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_detach_ctrls" 9 "nvme_ns_detach_ctrls" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_detach_ctrls" 9 "nvme_ns_detach_ctrls" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_detach_ctrls \- Detach namespace from controllers
 .SH SYNOPSIS
index 8c3e340de4664470cef73a8a8070bcac05ed5538..88ef5f182b3e46429239ef39d68d8a3c999fea58 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_flush" 9 "nvme_ns_flush" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_flush" 9 "nvme_ns_flush" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_flush \- Flush data to a namespace
 .SH SYNOPSIS
index c862bc7dfc9d2aa2332c5866e0c83365b50684bd..1f48d89f336f300537be906e64d6a95cb49c8859 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_csi" 9 "nvme_ns_get_csi" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_csi" 9 "nvme_ns_get_csi" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_csi \- Command set identifier of a namespace
 .SH SYNOPSIS
index a4262eff20c4dacb8fdb88b585b2c39231c1bfee..04d740582d4bcd1ba7210ad54c8bff8a1d710da5 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_ctrl" 9 "nvme_ns_get_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_ctrl" 9 "nvme_ns_get_ctrl" "October 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_eui64.2 b/doc/man/nvme_ns_get_eui64.2
new file mode 100644 (file)
index 0000000..0e2d46a
--- /dev/null
@@ -0,0 +1,11 @@
+.TH "nvme_ns_get_eui64" 9 "nvme_ns_get_eui64" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_ns_get_eui64 \- 64-bit eui of a namespace
+.SH SYNOPSIS
+.B "const uint8_t *" nvme_ns_get_eui64
+.BI "(nvme_ns_t n "  ");"
+.SH ARGUMENTS
+.IP "n" 12
+Namespace instance
+.SH "RETURN"
+A pointer to the 64-bit eui
index 29d90abcd83aca31c7a639641c6ee3a803094b5b..21f89c45a5468812c086397ef76d97aff4cd353c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_fd" 9 "nvme_ns_get_fd" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_fd" 9 "nvme_ns_get_fd" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_fd \- Get associated file descriptor
 .SH SYNOPSIS
index 0511f752e50a5b63805dc23059bf71c97023a9f5..c9a6a7e5d9ab1e0cb18e0f3f886f46cbae1e8315 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_firmware" 9 "nvme_ns_get_firmware" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_firmware" 9 "nvme_ns_get_firmware" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_firmware \- Firmware string of a namespace
 .SH SYNOPSIS
index 3e5065ee72b07009ffeadfc779ae9c1012ecd80d..5c0fe3665aa3ee767648a04889cdb5ff61148369 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_generic_name" 9 "nvme_ns_get_generic_name" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_generic_name" 9 "nvme_ns_get_generic_name" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_generic_name \- Returns name of generic namespace chardev.
 .SH SYNOPSIS
index 40f9eb312538aae2048a7d3814bb24f6edc541c7..1827dcdac9d2dbaf2b54bd8dbedae6f509d51507 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_lba_count" 9 "nvme_ns_get_lba_count" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_lba_count" 9 "nvme_ns_get_lba_count" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_lba_count \- LBA count of a namespace
 .SH SYNOPSIS
index 9845e91e4ec76e85a8478e478d7bec952c348fa2..ca1c6bcb8fec50cfbdbacc6825b700be8b8e5497 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_lba_size" 9 "nvme_ns_get_lba_size" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_lba_size" 9 "nvme_ns_get_lba_size" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_lba_size \- LBA size of a namespace
 .SH SYNOPSIS
index 805185a629a3470001ab2d6ddd983b0b03f92b08..c35b360c436ff89112e695b894405b750823365a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_lba_util" 9 "nvme_ns_get_lba_util" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_lba_util" 9 "nvme_ns_get_lba_util" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_lba_util \- LBA utilization of a namespace
 .SH SYNOPSIS
index 2a400732e1926f099a2e3b365ac2de0f749ac33a..4bd09404cda579e5c20cc20dc51d5a37abdd3ddc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_meta_size" 9 "nvme_ns_get_meta_size" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_meta_size" 9 "nvme_ns_get_meta_size" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_meta_size \- Metadata size of a namespace
 .SH SYNOPSIS
index ffa16f9dc7a864b12cc146c164a5a147ef3239bd..223ff0166040fc780223ce8f7eab6ceaaf140056 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_model" 9 "nvme_ns_get_model" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_model" 9 "nvme_ns_get_model" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_model \- Model of a namespace
 .SH SYNOPSIS
index b4f417257c20e96af37ca61915da2d8916847a56..c25bd935976f796308eb79471949cb55d02f3b2c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_name" 9 "nvme_ns_get_name" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_name" 9 "nvme_ns_get_name" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_name \- sysfs name of a namespace
 .SH SYNOPSIS
index 2c240b18d33898a8aacafd4c5fda69ed11fbf772..cecd646890f5629cef8f726d26c85005e3e45324 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_nguid" 9 "nvme_ns_get_nguid" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_nguid" 9 "nvme_ns_get_nguid" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_nguid \- 128-bit nguid of a namespace
 .SH SYNOPSIS
index 30ee3c948f8ecf135d84574c70f1f3f2628473f1..0212042670c79191f36cbf279a409a213874bd60 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_nsid" 9 "nvme_ns_get_nsid" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_nsid" 9 "nvme_ns_get_nsid" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_nsid \- NSID of a namespace
 .SH SYNOPSIS
index 49d3f6f70c4bc032769d883e920725c7c4b7ec7b..4ab27b3d29c9710dcd3d28eb3b4c8fe355c459c7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_serial" 9 "nvme_ns_get_serial" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_serial" 9 "nvme_ns_get_serial" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_serial \- Serial number of a namespace
 .SH SYNOPSIS
index ca9ef5b335ff6a6baf6286c99a07e67a57a4dbc4..2d20ba971d7a29a5ca044a2f1d29cbaeb3e415e9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_subsystem" 9 "nvme_ns_get_subsystem" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_subsystem" 9 "nvme_ns_get_subsystem" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_subsystem \- &nvme_subsystem_t of a namespace
 .SH SYNOPSIS
index ac6fcfe6dd932fab339535a66fc7cf085c5c047f..51ff7de5ea564e8018c7faf2d3a4282704da7bc1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_get_sysfs_dir" 9 "nvme_ns_get_sysfs_dir" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_sysfs_dir" 9 "nvme_ns_get_sysfs_dir" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_sysfs_dir \- sysfs directory of a namespace
 .SH SYNOPSIS
index 8215345222cbf1a47753ee42f72822351a12dfd8..b471d5599460c26211023f640335fbcd1da3b106 100644 (file)
@@ -1,10 +1,10 @@
-.TH "nvme_ns_get_uuid" 9 "nvme_ns_get_uuid" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_get_uuid" 9 "nvme_ns_get_uuid" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_get_uuid \- UUID of a namespace
 .SH SYNOPSIS
 .B "void" nvme_ns_get_uuid
 .BI "(nvme_ns_t n "  ","
-.BI "uuid_t out "  ");"
+.BI "unsigned char out[NVME_UUID_LEN] "  ");"
 .SH ARGUMENTS
 .IP "n" 12
 Namespace instance
index f2ea76a77f9d19623ccfb290513c99b6dd9201ef..a8a7567fccf47345dd8917f155422f8fb91b27c2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_ns_id_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ns_id_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_ns_id_desc \- Namespace identifier type descriptor
 .SH SYNOPSIS
index 5cfb1d7e38640113f8e24e508a016bb7cd8ee666..7177ccb8542092ac3fbde46345b998ad1bd97f24 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ns_id_desc_nidt" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ns_id_desc_nidt" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ns_id_desc_nidt \- Known namespace identifier types
 .SH SYNOPSIS
index 2375306369ac3a64b1d6afe0874eff379c5d4a4a..5e522a04678488acfea34620cc01e87343818551 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_identify" 9 "nvme_ns_identify" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_identify" 9 "nvme_ns_identify" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_identify \- Issue an 'identify namespace' command
 .SH SYNOPSIS
index 98d77b90a1abbf9c41d0eb8d4a65c8f87e8177a0..a7279358621bd224ada5ffc26315ba9aea1f871e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_identify_descs" 9 "nvme_ns_identify_descs" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_identify_descs" 9 "nvme_ns_identify_descs" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_identify_descs \- Issue an 'identify descriptors' command
 .SH SYNOPSIS
index 6443a71b560b54a7dc0b83f780b8f9b3d9de1e04..8e3f7873ebc85d7cf2ca6e65eaf3aa47cf6b38f7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_ns_list" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_ns_list" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_ns_list \- Namespace List
 .SH SYNOPSIS
index cc10b8d6f537475cc239844a28f51e38ccf2fedf..8d874a8bd0952990430e5466f3cda6e9472e2836 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ns_metadata_type" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ns_metadata_type" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ns_metadata_type \- Namespace Metadata Element Types
 .SH SYNOPSIS
index 3013a2ec37ba70a88d87180962ee8e7c9273f48d..04d3e51f8f2cdd662c4dd20a840d549d64c07dc3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_mgmt" 9 "nvme_ns_mgmt" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_mgmt" 9 "nvme_ns_mgmt" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_mgmt \- Issue a Namespace management command
 .SH SYNOPSIS
index 7060941f7095e559f69b81314af888068f1a0e64..896332c07670243179e61317fe493c0725745d46 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_mgmt_create" 9 "nvme_ns_mgmt_create" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_mgmt_create" 9 "nvme_ns_mgmt_create" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_mgmt_create \- Create a non attached namespace
 .SH SYNOPSIS
index 4993ed41fe79a1ca4f7324ef7216e5e1094c0bf0..b60654b4a1a1b9f46899b1ac717d8ddc6c41febb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_mgmt_delete" 9 "nvme_ns_mgmt_delete" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_mgmt_delete" 9 "nvme_ns_mgmt_delete" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_mgmt_delete \- Delete a non attached namespace
 .SH SYNOPSIS
index 4d76f29c242716cd899a8a96f79d27eb87617f9e..947ca7b9efe331c2e8498fa64b5d22e739ed4094 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ns_mgmt_sel" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ns_mgmt_sel" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ns_mgmt_sel \- Namespace Management - Select
 .SH SYNOPSIS
index 9e5386e3921a9bb9df4881a0549354cf4c085240..682ca1427a2de44e6f424d215311b2c7ce781794 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_read" 9 "nvme_ns_read" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_read" 9 "nvme_ns_read" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_read \- Read from a namespace
 .SH SYNOPSIS
index 0db76a0870ea45f94045d8c9a98a6156f21ba927..a483c0b0edf03a51d4d598dc3fd96ca608000c6f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_rescan" 9 "nvme_ns_rescan" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_rescan" 9 "nvme_ns_rescan" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_rescan \- Initiate a controller rescan
 .SH SYNOPSIS
index 0a3712186760079719ac5d7e81dd5cc3feb0c048..48ce2fcc57d5d32705f65136c7a231185cde58ba 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_verify" 9 "nvme_ns_verify" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_verify" 9 "nvme_ns_verify" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_verify \- Verify data on a namespace
 .SH SYNOPSIS
index 594496701a930a78f78e888cd8c2e00de43cd413..b671d37d203f128be7285e18ef62b65168fa38b8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_write" 9 "nvme_ns_write" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_write" 9 "nvme_ns_write" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_write \- Write to a namespace
 .SH SYNOPSIS
index f6f7e46baeac8502552f5fb4b4fde05ba1a1be40..0987434ffa7f1e27d89bb294eb7a3994cb8c9cdf 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_ns_write_protect_cfg" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_ns_write_protect_cfg" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_ns_write_protect_cfg \- Write Protection - Write Protection State
 .SH SYNOPSIS
index b4280d73b8c4d6698feb3a2147a3af82bb3eabec..944b9538ce6fdb051b50c3e29eb76aaa5b182589 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_write_uncorrectable" 9 "nvme_ns_write_uncorrectable" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_write_uncorrectable" 9 "nvme_ns_write_uncorrectable" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_write_uncorrectable \- Issus a 'write uncorrectable' command
 .SH SYNOPSIS
index 23543291740905dc923b2b87637a4ded94e637ec..132c83aade46b3c1012544dd118ce1009d880748 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_ns_write_zeros" 9 "nvme_ns_write_zeros" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_ns_write_zeros" 9 "nvme_ns_write_zeros" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_ns_write_zeros \- Write zeros to a namespace
 .SH SYNOPSIS
index 870bc84f97cd53b3dd8c77ccba237136128499c4..ad38206fc30c7442d3c332e6c97401b32a435a01 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_nss_hw_err_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_nss_hw_err_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_nss_hw_err_event \- NVM Subsystem Hardware Error Event
 .SH SYNOPSIS
index 14e150a7aa84380d7fd62f68ddd507cdc2b3e3cc..8bfc16ff8331cb74da6880dc9181c65176055985 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_nvm_id_ns" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_nvm_id_ns" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_nvm_id_ns \- NVME Command Set I/O Command Set Specific Identify Namespace Data Structure
 .SH SYNOPSIS
index f5e89ac0c1610baf67d290ec5ccbc755df49b23d..8e466dd7de8026d07e2a50756e8bf115a90e7dc5 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_nvm_id_ns_elbaf" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_nvm_id_ns_elbaf" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_nvm_id_ns_elbaf \- This field indicates the extended LBA format
 .SH SYNOPSIS
index 93083bf2fafb74ee059b41c8c4005824d59c30c7..541143ffa1d7264b9cf4e204bb6bb7b4a27f62be 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_nvm_identify_ctrl" 9 "nvme_nvm_identify_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_nvm_identify_ctrl" 9 "nvme_nvm_identify_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_nvm_identify_ctrl \- Identify controller data
 .SH SYNOPSIS
index b8ab7e9c915b2ff037af553e366cb2e19a65325e..fbb2ea4238bb4311f8572766c26c0f5a66e778bb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_nvmeset_pl_status" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_nvmeset_pl_status" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_nvmeset_pl_status \- Predictable Latency Per NVM Set Log - Status
 .SH SYNOPSIS
index d9858123ce14794fecff28009098168773d7e75c..92210da1a6468cb10beb6c29c836ab4db872df4c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_nvmset_attr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_nvmset_attr" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_nvmset_attr \- NVM Set Attributes Entry
 .SH SYNOPSIS
index 224328021c13e2403190ea68e69a4c4dee61703b..7f74421715e239b1800f2e58fd08c0aa596c10b9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_nvmset_pl_events" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_nvmset_pl_events" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_nvmset_pl_events \- Predictable Latency Per NVM Set Log - Event Type
 .SH SYNOPSIS
index 85432d9353d918526ad9d4ad081f0f95aec00e0d..ec9994b0d1a987fe7f21e3d8a275078d6a0a553e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_nvmset_predictable_lat_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_nvmset_predictable_lat_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_nvmset_predictable_lat_log \- Predictable Latency Mode - Deterministic Threshold Configuration Data
 .SH SYNOPSIS
index cb10cbe48bea39c1a3fe59a35efb324242676e89..370f86ce59957e36ceb9f1bf11f166aea7d25647 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_open" 9 "nvme_open" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_open" 9 "nvme_open" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_open \- Open an nvme controller or namespace device
 .SH SYNOPSIS
index b73ff943d65a5cf79ebf30c910724ad80380c1d9..7528ccc49bafbf5aa6d1ff3b0a4a8b9d2ba539cb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_passthru_cmd" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_passthru_cmd" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_passthru_cmd \- nvme passthrough command structure
 .SH SYNOPSIS
diff --git a/doc/man/nvme_passthru_cmd64.2 b/doc/man/nvme_passthru_cmd64.2
new file mode 100644 (file)
index 0000000..82de2f7
--- /dev/null
@@ -0,0 +1,87 @@
+.TH "libnvme" 9 "struct nvme_passthru_cmd64" "October 2022" "API Manual" LINUX
+.SH NAME
+struct nvme_passthru_cmd64 \- 64-bit nvme passthrough command structure
+.SH SYNOPSIS
+struct nvme_passthru_cmd64 {
+.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 "    __u64 result;"
+.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
+.IP "result" 12
+Set on completion to the command's CQE DWORD 0-1 controller response
index ab63ffd0a3e752390a5ffcf47411202ace00d8c8..d99f00f8d4d7c83c090737b3999cbf020c40070a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_path_get_ana_state" 9 "nvme_path_get_ana_state" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_path_get_ana_state" 9 "nvme_path_get_ana_state" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_path_get_ana_state \- ANA state of an nvme_path_t object
 .SH SYNOPSIS
index 1db55a97432ea114750b501ff7177371b8e2eca0..d4867183e1e8e32f6727428062f0515a6ffe2fee 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_path_get_ctrl" 9 "nvme_path_get_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_path_get_ctrl" 9 "nvme_path_get_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_path_get_ctrl \- Parent controller of an nvme_path_t object
 .SH SYNOPSIS
index 9aa970e5cc059ca70ea320bdac08fb8fc9afaf3e..4c8f4b4dd32432c65d2272fcd31edbf870576509 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_path_get_name" 9 "nvme_path_get_name" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_path_get_name" 9 "nvme_path_get_name" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_path_get_name \- sysfs name of an &nvme_path_t object
 .SH SYNOPSIS
index 3a91217ebc2237a0653ce725dfb7654914ff6b88..fbd96294099f188896381cb286ec99967a3db5de 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_path_get_ns" 9 "nvme_path_get_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_path_get_ns" 9 "nvme_path_get_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_path_get_ns \- Parent namespace of an nvme_path_t object
 .SH SYNOPSIS
index 1bdad2af57f4a8d869f3ce0a1c4308316c40da5b..4c7e01a7216d8c1c9422ef11e68771d5cf32bbee 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_path_get_sysfs_dir" 9 "nvme_path_get_sysfs_dir" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_path_get_sysfs_dir" 9 "nvme_path_get_sysfs_dir" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_path_get_sysfs_dir \- sysfs directory of an nvme_path_t object
 .SH SYNOPSIS
index 10b7f8661cbb6778a8c730c2de33b6e1b22c118f..1825634520c32172bb4ff60a1241807f0c2b9f0a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_paths_filter" 9 "nvme_paths_filter" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_paths_filter" 9 "nvme_paths_filter" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_paths_filter \- Filter for paths
 .SH SYNOPSIS
index 36effd1a00ec39228b20ce26dc6a0a35972dea08..9a7e795814e386a18d37cdc800e99ce2d9bbf057 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_persistent_event_entry" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_persistent_event_entry" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_persistent_event_entry \- Persistent Event
 .SH SYNOPSIS
index 1bd69af70a303f19a3014ced3ea8275ca2ead623..59d4866584fba247a522612ce3e69c6f6a62c59c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_persistent_event_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_persistent_event_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_persistent_event_log \- Persistent Event Log
 .SH SYNOPSIS
index cad8aacca90c6740fa0125320b21f38a35ee20f2..2b96a9bc184a176aaae417edc7b3dcd930b207b0 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_persistent_event_types" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_persistent_event_types" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_persistent_event_types \- Persistent event log events
 .SH SYNOPSIS
index 7eaebb78e966c6f20ae44736cb4db4e46df7cc22..237333692dccd9704f65591507edc69caad53156 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_pevent_log_action" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_pevent_log_action" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_pevent_log_action \- Persistent Event Log - Action
 .SH SYNOPSIS
index 7d33cc98bbc9348e989dfb69b823fd089f22a422..7aad2e145463471ead61cd5420a79825b22807b3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_plm_config" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_plm_config" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_plm_config \- Predictable Latency Mode - Deterministic Threshold Configuration Data Structure
 .SH SYNOPSIS
index 94a95f11cbaac4057c36960c35159a53547c38b6..6c351944822575221d89ce2d7b102cda0596e899 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_pmr_size" 9 "nvme_pmr_size" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_pmr_size" 9 "nvme_pmr_size" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_pmr_size \- Calculate size of persistent memory region elasticity buffer
 .SH SYNOPSIS
index 3390e32a1d6c5e6faba78c77efcf06c6b9edcc9a..807caac92eb48ef6255e75d0f4041a7347394064 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_pmr_throughput" 9 "nvme_pmr_throughput" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_pmr_throughput" 9 "nvme_pmr_throughput" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_pmr_throughput \- Calculate throughput of persistent memory buffer
 .SH SYNOPSIS
index 7f67adb06958708b61b02a83e8f0e558df923ff8..ff6d5eb5085ec93c65bfea5acb86b1bd0e3a282e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_power_on_reset_info_list" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_power_on_reset_info_list" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_power_on_reset_info_list \- Controller Reset Information
 .SH SYNOPSIS
index b47dc0de0ef151252ba4cb3af26ca1e4de88b7f8..da6a29643987add7645df847497988f1f0892854 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_primary_ctrl_cap" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_primary_ctrl_cap" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_primary_ctrl_cap \- Identify - Controller Capabilities Structure
 .SH SYNOPSIS
index b14551a4c6a9041f0a59be2b408a029b011fc7a9..aa92507971b3fada818138124ee1301074e7ecd5 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_psd_flags" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_psd_flags" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_psd_flags \- Possible flag values in nvme power state descriptor
 .SH SYNOPSIS
index 3548b5c76dfbf8e73b8ba9efea36d5388c0598d0..2b95fc2652e66ae91da1e63d50c37a78287cf1b7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_psd_power_scale" 9 "nvme_psd_power_scale" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_psd_power_scale" 9 "nvme_psd_power_scale" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_psd_power_scale \- power scale occupies the upper 3 bits
 .SH SYNOPSIS
index 66473b7304f09afe54d498476ebced601dcb8a40..4efe647618dd1910dde54610c39a2757c8ad3d83 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_psd_ps" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_psd_ps" "October 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
index 61f01d34a50faef2aae7608bae3ed2fcc29108c3..82f156656dd859a909b032c6e292793726620dae 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_psd_workload" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_psd_workload" "October 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
index b7090032e33eb882335cad37f7c4253fbdf3e89a..bfd8bd120667da19df1e3fe4fdc7c7a861c57411 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_read" 9 "nvme_read" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_read" 9 "nvme_read" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_read \- Submit an nvme user read command
 .SH SYNOPSIS
index 06b165134932c29ec5a9f582721b6abd054a9894..a262cb37119cf5d027c0a979f54a463ef19471ed 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_read_config" 9 "nvme_read_config" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_read_config" 9 "nvme_read_config" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_read_config \- Read NVMe JSON configuration file
 .SH SYNOPSIS
index 291b78831003e65494630c4c0139fd9b5fa094cf..6d71be0e5b7e52f27b948bd2302f383a4e24784e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_refresh_topology" 9 "nvme_refresh_topology" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_refresh_topology" 9 "nvme_refresh_topology" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_refresh_topology \- Refresh nvme_root_t object contents
 .SH SYNOPSIS
index 708d74344edba9b66d5d39e83acd52ec33cbfdaf..eb29c1bc57a99e5ca5c8273d4f2387b9f4e23fc9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_register_offsets" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_register_offsets" "October 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
index 3a8f24a18c7e0c2c089dae06bbc47d06b9401ab7..bb0054fd7992578c37e475223112da90d6263ead 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_registered_ctrl" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_registered_ctrl" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_registered_ctrl \- Registered Controller Data Structure
 .SH SYNOPSIS
index 92a591e53269057059e5d19287b688c4540ccdca..12825b47cc5b4dd3e5a1b32e286305f83aa46829 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_registered_ctrl_ext" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_registered_ctrl_ext" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_registered_ctrl_ext \- Registered Controller Extended Data Structure
 .SH SYNOPSIS
index a100e3a7ca03f3b0f725110d4ace80d5713ca066..f4ab5eca4ff6b90ae485fe1ca5dc15e270f2e47c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_rescan_ctrl" 9 "nvme_rescan_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_rescan_ctrl" 9 "nvme_rescan_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_rescan_ctrl \- Rescan an existing controller
 .SH SYNOPSIS
index d31c092095c3d397764e7998ab1d1a15b2144b96..4374637cc2f59337573466010c7882d908407228 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_resv_acquire" 9 "nvme_resv_acquire" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_resv_acquire" 9 "nvme_resv_acquire" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_resv_acquire \- Send an nvme reservation acquire
 .SH SYNOPSIS
index 1b6c03298b1a755dccf1454e9aeeeb9f73b7f005..30ea56a368727bc55bd00c15bebdfb078e0cd701 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_resv_cptpl" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_cptpl" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_resv_cptpl \- Reservation Register - Change Persist Through Power Loss State
 .SH SYNOPSIS
index 166ab063bc035c216eb612dabba467a245f45c63..de2b0c34877a7b52675e6e7eb9f29ed5dcb2832a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_resv_notification_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_resv_notification_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_resv_notification_log \- Reservation Notification Log
 .SH SYNOPSIS
index 9d0953e24c726938cf380226710be29a890d5e59..2f3d25bf55dd428976ea0ce7344a0266dabba218 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_resv_notify_rnlpt" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_notify_rnlpt" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_resv_notify_rnlpt \- Reservation Notification Log - Reservation Notification Log Page Type
 .SH SYNOPSIS
index cb8663257b1ff274f14ab7fe5aebb8cda3f03ba0..94351c093328a06a380526d514117297ab2f797f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_resv_racqa" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_racqa" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_resv_racqa \- Reservation Acquire - Reservation Acquire Action
 .SH SYNOPSIS
index ad3da937adc7fbe00eb7fb89ef3b7c4b7e7ce18b..1fdfc18d7fa28f73b02511b6c69bc4c74055ce4d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_resv_register" 9 "nvme_resv_register" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_resv_register" 9 "nvme_resv_register" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_resv_register \- Send an nvme reservation register
 .SH SYNOPSIS
index 8dd34d1015eb0348a5a1662ff23acf3f36b86de0..cb020963a662e7f1879528bf7949574ed1d97bc9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_resv_release" 9 "nvme_resv_release" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_resv_release" 9 "nvme_resv_release" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_resv_release \- Send an nvme reservation release
 .SH SYNOPSIS
index a1b9d3ba7878567b72797935af44140498e1de29..2760676e1abdcff7f8ac78a67b9a5e6e9e65bfcb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_resv_report" 9 "nvme_resv_report" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_resv_report" 9 "nvme_resv_report" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_resv_report \- Send an nvme reservation report
 .SH SYNOPSIS
index dc0d5c4edd97e02525ac85b7e3884f68b68ea8c6..08996f92bd5efe70aa9f616b15ef498e2981f5dd 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_resv_rrega" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_rrega" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_resv_rrega \- Reservation Register - Reservation Register Action
 .SH SYNOPSIS
index 75c79e53a7a452f8f10054b0f3315eceba30885e..701772376fcf36379d760ba80704a4d6a960ac03 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_resv_rrela" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_rrela" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_resv_rrela \- Reservation Release - Reservation Release Action
 .SH SYNOPSIS
index 2354ceb53c232bf8744bc33b62200b7b7651a934..0e4d39226c55058f73a9cf1d34a1bb1397ba7a14 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_resv_rtype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_resv_rtype" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_resv_rtype \- Reservation Type Encoding
 .SH SYNOPSIS
index 20ebfecc0aceea93be62c84c234d29261d8f3189..241452c0a7c8926d892236f6a2261579bf20abaf 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_resv_status" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_resv_status" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_resv_status \- Reservation Status Data Structure
 .SH SYNOPSIS
index 8ac2be6d6ed91d4f3cc323de981e2299f0024c46..f3c4251ea554d890327c7d8bf34bc03e61aa7405 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_sanitize_compln_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_sanitize_compln_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_sanitize_compln_event \- Sanitize Completion Event Data
 .SH SYNOPSIS
index f04ceb94bf9322cc9b27f75acff9c1e966efe0f9..c7fdbd76bf48f9ddbe33d71d092c04a6cb81189e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_sanitize_log_page" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_sanitize_log_page" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_sanitize_log_page \- Sanitize Status (Log Identifier 81h)
 .SH SYNOPSIS
index f711c8dcf70bde4f8fb350979ed42aa34dc90280..823ee494abe89beb2787cb37c47debd3d266de57 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_sanitize_nvm" 9 "nvme_sanitize_nvm" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_sanitize_nvm" 9 "nvme_sanitize_nvm" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_sanitize_nvm \- Start a sanitize operation
 .SH SYNOPSIS
index 3eb397edcf023666165141a873821f1b68b4fdbc..668d08f2b8293753a6ee995ec83e9c9aae186323 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_sanitize_sanact" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_sanitize_sanact" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_sanitize_sanact \- Sanitize Action
 .SH SYNOPSIS
index e9e66eab700c6b3eddaece6221d540f86369df9e..c2c078139621b3c8cc24b963ec36bf148a2e0c0e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_sanitize_sstat" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_sanitize_sstat" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_sanitize_sstat \- Sanitize Status (SSTAT)
 .SH SYNOPSIS
index a092ca34d2fd6af9d3a71a007d2d978240b4f998..6813feef01cee016ca4e1983fe024cce368d1e97 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_sanitize_start_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_sanitize_start_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_sanitize_start_event \- Sanitize Start Event Data
 .SH SYNOPSIS
index 98214689ae61afc166d8eef01908d71a3e435358..e4bb31c15b3b4b13bd06099d1c07eeb02099dc01 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_scan" 9 "nvme_scan" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_scan" 9 "nvme_scan" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_scan \- Scan NVMe topology
 .SH SYNOPSIS
index 594136b602a1298cb325af9acc682327a56fe5f2..4d324edc35dc7b7854e88f93adabdde41749e98b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_scan_ctrl" 9 "nvme_scan_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_scan_ctrl" 9 "nvme_scan_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_scan_ctrl \- Scan on a controller
 .SH SYNOPSIS
index 7ab944f80cf7e8c002ed7ebb0a6c71db19013c05..81cd4c0536b2e79612f75f61c11ed69a0284a8e1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_scan_ctrl_namespace_paths" 9 "nvme_scan_ctrl_namespace_paths" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_scan_ctrl_namespace_paths" 9 "nvme_scan_ctrl_namespace_paths" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_scan_ctrl_namespace_paths \- Scan for namespace paths in a controller
 .SH SYNOPSIS
index ecfe99cab75959dc83eec66435f0535605fea433..2426c0588502cf9db698048f92e7650c175083ff 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_scan_ctrl_namespaces" 9 "nvme_scan_ctrl_namespaces" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_scan_ctrl_namespaces" 9 "nvme_scan_ctrl_namespaces" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_scan_ctrl_namespaces \- Scan for namespaces in a controller
 .SH SYNOPSIS
index 6708e4f9c3eae50b12627244019bffbb993effaa..25fd677e96d6061ac1a44df11cc981bc0f8f3c2a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_scan_ctrls" 9 "nvme_scan_ctrls" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_scan_ctrls" 9 "nvme_scan_ctrls" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_scan_ctrls \- Scan for controllers
 .SH SYNOPSIS
index f7cfc5f708b0e229e11362ef5618c4d0219f47b7..2e2fb617a9672d5fcece64f57ce2fa0e72ea7d71 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_scan_namespace" 9 "nvme_scan_namespace" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_scan_namespace" 9 "nvme_scan_namespace" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_scan_namespace \- scan namespace based on sysfs name
 .SH SYNOPSIS
index cf45aa00a0848f7d086d5ba727e6942ceb41160b..8d7b20888a7cd183f61f6ea7e08766822737144c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_scan_subsystem_namespaces" 9 "nvme_scan_subsystem_namespaces" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_scan_subsystem_namespaces" 9 "nvme_scan_subsystem_namespaces" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_scan_subsystem_namespaces \- Scan for namespaces in a subsystem
 .SH SYNOPSIS
index da59ebda326576bb4acf1dc1dbdccb7d7fdc8030..00bc922914fbbe468463641df57e46ce93342839 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_scan_subsystems" 9 "nvme_scan_subsystems" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_scan_subsystems" 9 "nvme_scan_subsystems" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_scan_subsystems \- Scan for subsystems
 .SH SYNOPSIS
index 715556418a963d31c26501fea4bcce63493dd814..c548138cccbc68e7da9c39e1480bf7fdffaf8e75 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_scan_topology" 9 "nvme_scan_topology" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_scan_topology" 9 "nvme_scan_topology" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_scan_topology \- Scan NVMe topology and apply filter
 .SH SYNOPSIS
index 2bce2942c0bb60debc4887285839b69b0979855a..40c1601b3324f47c311711e8276808d3a20e7e42 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_secondary_ctrl" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_secondary_ctrl" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_secondary_ctrl \- Secondary Controller Entry
 .SH SYNOPSIS
index 2b8b773fd4e64db54a5f9e14a862ba23705970b9..42a051051996aca00a8e06c42ab2dcf84b93412a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_secondary_ctrl_list" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_secondary_ctrl_list" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_secondary_ctrl_list \- Secondary Controller List
 .SH SYNOPSIS
index c10c35e814785aa4613a1d77619589edfe35a69a..298238efc0f32df60af15d10c403b3e83f4ef617 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_security_receive" 9 "nvme_security_receive" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_security_receive" 9 "nvme_security_receive" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_security_receive \- Security Receive command
 .SH SYNOPSIS
index d3ae84cc29a94ceb067c5056817cd55283a77c12..fc2fe04a2c4d8ef1b9807d281e5ad7e0a69f92e4 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_security_send" 9 "nvme_security_send" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_security_send" 9 "nvme_security_send" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_security_send \- Security Send command
 .SH SYNOPSIS
index 215a896ce742312dd465ccffd80f09fac4e16285..1fa2d79266c6ed006ed725ec33048cc59bdb86b3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_self_test_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_self_test_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_self_test_log \- Device Self-test (Log Identifier 06h)
 .SH SYNOPSIS
index 003401790728494b9ec47c5675e8867826a25f88..54eb128b69604fc653abf95b778230988e10496e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_set_feature_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_set_feature_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_set_feature_event \- Set Feature Event Data
 .SH SYNOPSIS
index c23014b004980150f9120ae018db59496d2c8f0e..818deaad488ed7a6ae1a63f38644e3f4d42dcd6c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features" 9 "nvme_set_features" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features" 9 "nvme_set_features" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features \- Set a feature attribute
 .SH SYNOPSIS
index 2f4afa59a201f2238660b74febf22d935ec23554..0f5179ef35bb33476d312c2cc749a696fd57919b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_arbitration" 9 "nvme_set_features_arbitration" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_arbitration" 9 "nvme_set_features_arbitration" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_arbitration \- Set arbitration features
 .SH SYNOPSIS
index 97f9e70b8eff2bfd9df5eb3cfcb80ff3f5589e42..6f3a8998973a884a54505a735b517d793d8b550a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_async_event" 9 "nvme_set_features_async_event" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_async_event" 9 "nvme_set_features_async_event" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_async_event \- Set asynchronous event feature
 .SH SYNOPSIS
index 99ae9a866c5fb197a535cb440d984b49c0d693f0..8a8cc913657d571848c71a540bb340e09d952fce 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_auto_pst" 9 "nvme_set_features_auto_pst" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_auto_pst" 9 "nvme_set_features_auto_pst" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_auto_pst \- Set autonomous power state feature
 .SH SYNOPSIS
index ae4998893df963b3fa8c2bfc562ee63f325b533e..73c2e690edce1af7298af8a0743f7d4139d779ac 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_data" 9 "nvme_set_features_data" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_data" 9 "nvme_set_features_data" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_data \- Helper function for @nvme_set_features()
 .SH SYNOPSIS
index 0acb6d2ec587f92feda7bedfb9afbbcff0714a89..5c4afcc5cf1561c80ada0f89cf93d0a41a8b23e8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_endurance_evt_cfg" 9 "nvme_set_features_endurance_evt_cfg" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_endurance_evt_cfg" 9 "nvme_set_features_endurance_evt_cfg" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_endurance_evt_cfg \- Set endurance event config feature
 .SH SYNOPSIS
index a277c96cb7f93b50b9ece785d92e2c90b32769aa..3f1646df4ddf1546b9a39d3bb63ed8de72494f5d 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_err_recovery" 9 "nvme_set_features_err_recovery" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_err_recovery" 9 "nvme_set_features_err_recovery" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_err_recovery \- Set error recovery feature
 .SH SYNOPSIS
index c1a88c5a0f321c73f3b0959f9b3cc7f1e1aaf8eb..422ba43d54b6ebb406d2a6ca7d0ea366f7dfd854 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_hctm" 9 "nvme_set_features_hctm" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_hctm" 9 "nvme_set_features_hctm" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_hctm \- Set thermal management feature
 .SH SYNOPSIS
index 2f1cd4b8c4a05ef5776617c58b63a05521c00650..af29adf07b52bae73c97e10b3d85d896ffc37219 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_host_behavior" 9 "nvme_set_features_host_behavior" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_host_behavior" 9 "nvme_set_features_host_behavior" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_host_behavior \- Set host behavior feature
 .SH SYNOPSIS
index 00e49437512f4085ebd5de4026bb176fdb2dcd3f..1d269b31cc26927be405e24eb1d291ea421cceb1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_host_id" 9 "nvme_set_features_host_id" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_host_id" 9 "nvme_set_features_host_id" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_host_id \- Set enable extended host identifers feature
 .SH SYNOPSIS
index 68a85d1bf9129878cb5db032aaac80c01cf8d191..c55dbe6c35c50597e8501bc5e2ceb6137d1a9692 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_irq_coalesce" 9 "nvme_set_features_irq_coalesce" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_irq_coalesce" 9 "nvme_set_features_irq_coalesce" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_irq_coalesce \- Set IRQ coalesce feature
 .SH SYNOPSIS
index 151504539f3f6a2ccdb29fc52404231af419a471..2116c43a4987cc32b17531c5b6edbf613cf90e46 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_irq_config" 9 "nvme_set_features_irq_config" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_irq_config" 9 "nvme_set_features_irq_config" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_irq_config \- Set IRQ config feature
 .SH SYNOPSIS
index 7d745ee95e780beb69d3c1e1840bebd05e948898..f366d15e00a00eede25c338069635c09adb14e83 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_lba_range" 9 "nvme_set_features_lba_range" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_lba_range" 9 "nvme_set_features_lba_range" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_lba_range \- Set LBA range feature
 .SH SYNOPSIS
index c799cf9f7e84a0fb1d85e77892ed41b065caeab2..ca5238c474000cf57ea268bb33200445ad3c7d47 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_lba_sts_interval" 9 "nvme_set_features_lba_sts_interval" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_lba_sts_interval" 9 "nvme_set_features_lba_sts_interval" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_lba_sts_interval \- Set LBA status information feature
 .SH SYNOPSIS
index 8eed53931a4f7cd77f7c7f2a96893d1c498b94d8..78370165a47279acf8df6c48071b00d71e2cc138 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_nopsc" 9 "nvme_set_features_nopsc" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_nopsc" 9 "nvme_set_features_nopsc" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_nopsc \- Set non-operational power state feature
 .SH SYNOPSIS
index 74ab6e162330410948daa4a8e463481de8c27eff..acc006286981b2fa21a17c1631f9f29227309875 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_plm_config" 9 "nvme_set_features_plm_config" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_plm_config" 9 "nvme_set_features_plm_config" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_plm_config \- Set predictable latency feature
 .SH SYNOPSIS
index e7bf3e5077683698198b971b8d63855c27f39983..dc9e537614ede3fcf68a9ed738d58ef3d69fb56b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_plm_window" 9 "nvme_set_features_plm_window" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_plm_window" 9 "nvme_set_features_plm_window" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_plm_window \- Set window select feature
 .SH SYNOPSIS
index 0a048e6664db493df084a0372e09b9c285d281fd..7a662b6fe1b35d801f3e42fb6d34dfc0df73808c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_power_mgmt" 9 "nvme_set_features_power_mgmt" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_power_mgmt" 9 "nvme_set_features_power_mgmt" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_power_mgmt \- Set power management feature
 .SH SYNOPSIS
index 2b9ebb74f324a39016a58ab8a71c658c1caf724b..b283bbddd548633f301d8f9da4b825ef6ee88199 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_resv_mask" 9 "nvme_set_features_resv_mask" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_resv_mask" 9 "nvme_set_features_resv_mask" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_resv_mask \- Set reservation notification mask feature
 .SH SYNOPSIS
index 2c6eeec9d1da4b30b4d3d15c9b99bb1e373edd1d..57e9a31255cd98f708a3221bb58e0702897c1529 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_resv_persist" 9 "nvme_set_features_resv_persist" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_resv_persist" 9 "nvme_set_features_resv_persist" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_resv_persist \- Set persist through power loss feature
 .SH SYNOPSIS
index ffa2c8e4909ea9482212c845e2f54d5a343c70f6..0b35db18034aa1fd8ac00c6478b336e642d1cb77 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_rrl" 9 "nvme_set_features_rrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_rrl" 9 "nvme_set_features_rrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_rrl \- Set read recovery level feature
 .SH SYNOPSIS
index f53839eefdef29b4bce1d186e8055458229a3503..5e874dba7b8cbef1a284548faf451a0635cd780e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_sanitize" 9 "nvme_set_features_sanitize" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_sanitize" 9 "nvme_set_features_sanitize" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_sanitize \- Set sanitize feature
 .SH SYNOPSIS
index 096b4dd181b43c3ee042640cbae8418730f21f80..1d82a396beaa1bc92536821e5e0dc5cb6bb96e68 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_simple" 9 "nvme_set_features_simple" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_simple" 9 "nvme_set_features_simple" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_simple \- Helper function for @nvme_set_features()
 .SH SYNOPSIS
index b9afa31f417841eff7a142b298bbdd16f54283bb..0350bfdd2ddbaa91a6d4636ee1daffa0c61d965a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_sw_progress" 9 "nvme_set_features_sw_progress" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_sw_progress" 9 "nvme_set_features_sw_progress" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_sw_progress \- Set pre-boot software load count feature
 .SH SYNOPSIS
index bcea1aac2c9ee60df4ccdaaa68e0799e59c14e9a..b04ccbd661a78cc4ce1f6a7d6eceb84525c5099e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_temp_thresh" 9 "nvme_set_features_temp_thresh" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_temp_thresh" 9 "nvme_set_features_temp_thresh" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_temp_thresh \- Set temperature threshold feature
 .SH SYNOPSIS
index 682d8b990343b8ec1ea959876d19162e73658862..3c572cf8dc39d1da68b9b1e932778e97f2f6623f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_timestamp" 9 "nvme_set_features_timestamp" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_timestamp" 9 "nvme_set_features_timestamp" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_timestamp \- Set timestamp feature
 .SH SYNOPSIS
index 4792972b9232ff3a042494f223fac904512b3476..ca05ebc40af180d5cf647a7f2af1989b2348fee2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_volatile_wc" 9 "nvme_set_features_volatile_wc" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_volatile_wc" 9 "nvme_set_features_volatile_wc" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_volatile_wc \- Set volatile write cache feature
 .SH SYNOPSIS
index 0cd8f688cede5f0a6f2183e9069dddc79e9e4328..bf7d80f6d0ef457f8f55511fc2568d0329f8b1b9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_write_atomic" 9 "nvme_set_features_write_atomic" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_write_atomic" 9 "nvme_set_features_write_atomic" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_write_atomic \- Set write atomic feature
 .SH SYNOPSIS
index 42fb1c35b8269e4c79916cec7f0d002d4f450279..3106cd7cee75e56cd24775114c7096ee4ad9e7fa 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_features_write_protect" 9 "nvme_set_features_write_protect" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_features_write_protect" 9 "nvme_set_features_write_protect" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_features_write_protect \- Set write protect feature
 .SH SYNOPSIS
index 2409097dc37faacb96a2fa42d3ce60e47aded39a..e15b5738e334fa695abdaf8f23c53afeed7d8b16 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_set_property" 9 "nvme_set_property" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_set_property" 9 "nvme_set_property" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_set_property \- Set controller property
 .SH SYNOPSIS
index f32f42eeae479e26fe38733205616f541ba38626..5dd636c5dc0fb762282a4993bac0f389719b1954 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_smart_crit" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_smart_crit" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_smart_crit \- Critical Warning
 .SH SYNOPSIS
index 91c8ff0933c0cb9a90cdc2cfed8aa8f4d1a80601..2f191049d2791620f7bbe8fb071f32d390db6bbb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_smart_egcw" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_smart_egcw" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_smart_egcw \- Endurance Group Critical Warning Summary
 .SH SYNOPSIS
index 27d8c422fd6900547133efcf3e8ad92abee5484a..32acefdb8d733e7f30cee38e69c1e8db6eddf168 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_smart_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_smart_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_smart_log \- SMART / Health Information Log (Log Identifier 02h)
 .SH SYNOPSIS
index 083649e346750cea9faf774d7a39e41d607aebfb..0bff08d9547e0960fee354bb6c4cab29f2ffaa20 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_st_code" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_st_code" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_st_code \- Self-test Code value
 .SH SYNOPSIS
index 7b6f907009daab8c83a517e9e6807bc935b62398..fc1983030419f48a0b510df6e876e4e7759ca602 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_st_curr_op" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_st_curr_op" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_st_curr_op \- Current Device Self-Test Operation
 .SH SYNOPSIS
index 3ebcace7244d5f88cc68c22a10d979b11127ad60..e4dca2b5097d376a98c4cc67bd401f7bc92f06d1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_st_result" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_st_result" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_st_result \- Self-test Result
 .SH SYNOPSIS
index cbc9e088c95b76794733b252fbfd5e27b560c1d9..8fc5b96d9adb0c5e95cbf3bf6f2ad8692525b5ae 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_st_valid_diag_info" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_st_valid_diag_info" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_st_valid_diag_info \- Valid Diagnostic Information
 .SH SYNOPSIS
index cca0c5a0da0a82432c50dad10ffdb1a6864bf7f5..84e6b7bf55c31d0929e22f24ee9e27b7f463be97 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_status_code" 9 "nvme_status_code" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_status_code" 9 "nvme_status_code" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_status_code \- Returns the NVMe Status Code
 .SH SYNOPSIS
index b3c97b89f01ca4469ec8cf9759de1f018a459dbd..eacecb20fd018ea27ff730f17458d684f726ee58 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_status_code_type" 9 "nvme_status_code_type" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_status_code_type" 9 "nvme_status_code_type" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_status_code_type \- Returns the NVMe Status Code Type
 .SH SYNOPSIS
diff --git a/doc/man/nvme_status_equals.2 b/doc/man/nvme_status_equals.2
new file mode 100644 (file)
index 0000000..55c3def
--- /dev/null
@@ -0,0 +1,17 @@
+.TH "nvme_status_equals" 9 "nvme_status_equals" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_status_equals \- helper to check a status against a type and value
+.SH SYNOPSIS
+.B "__u32" nvme_status_equals
+.BI "(int status "  ","
+.BI "enum nvme_status_type type "  ","
+.BI "unsigned int value "  ");"
+.SH ARGUMENTS
+.IP "status" 12
+the (non-negative) return value from the NVMe API
+.IP "type" 12
+the status type
+.IP "value" 12
+the status value
+.SH "RETURN"
+true if \fIstatus\fP is of the specified type and value
index ad358622ca238e05eeada2cdeeedb76c3aab9e88..e3234fc397c384aa3bdc2570bb581b3de617bac5 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_status_field" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_status_field" "October 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
diff --git a/doc/man/nvme_status_get_type.2 b/doc/man/nvme_status_get_type.2
new file mode 100644 (file)
index 0000000..addbea4
--- /dev/null
@@ -0,0 +1,11 @@
+.TH "nvme_status_get_type" 9 "nvme_status_get_type" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_status_get_type \- extract the type from a nvme_* return value
+.SH SYNOPSIS
+.B "__u32" nvme_status_get_type
+.BI "(int status "  ");"
+.SH ARGUMENTS
+.IP "status" 12
+the (non-negative) return value from the NVMe API
+.SH "RETURN"
+the type component of the status.
diff --git a/doc/man/nvme_status_get_value.2 b/doc/man/nvme_status_get_value.2
new file mode 100644 (file)
index 0000000..fbef5fa
--- /dev/null
@@ -0,0 +1,12 @@
+.TH "nvme_status_get_value" 9 "nvme_status_get_value" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_status_get_value \- extract the status value from a nvme_* return value
+.SH SYNOPSIS
+.B "__u32" nvme_status_get_value
+.BI "(int status "  ");"
+.SH ARGUMENTS
+.IP "status" 12
+the (non-negative) return value from the NVMe API
+.SH "RETURN"
+the value component of the status; the set of values will depend
+on the status type.
index 235dc9880ba6033e41b15ed81a0a232ba329ba53..df79a397c2ec66c150c2948d767144465ead6674 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_status_result" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_status_result" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_status_result \- Result of the device self-test operation
 .SH SYNOPSIS
index 5c16c11479ba4a0884b05d1bb089b2abf7bb6e8d..c047ed667b0d3bb96907fdc75b807e9dc54531fd 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_status_to_errno" 9 "nvme_status_to_errno" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_status_to_errno" 9 "nvme_status_to_errno" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_status_to_errno \- Converts nvme return status to errno
 .SH SYNOPSIS
index f192cc7499764cc0e17b27f86eef2015fe342015..614224d473d666694dbaba90e441ad8e9e7a55c6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_status_to_string" 9 "nvme_status_to_string" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_status_to_string" 9 "nvme_status_to_string" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_status_to_string \- Returns string describing nvme return status.
 .SH SYNOPSIS
diff --git a/doc/man/nvme_status_type.2 b/doc/man/nvme_status_type.2
new file mode 100644 (file)
index 0000000..60056ee
--- /dev/null
@@ -0,0 +1,40 @@
+.TH "libnvme" 9 "enum nvme_status_type" "October 2022" "API Manual" LINUX
+.SH NAME
+enum nvme_status_type \- type encoding for NVMe return values, when represented as an int.
+.SH SYNOPSIS
+enum nvme_status_type {
+.br
+.BI "    NVME_STATUS_TYPE_SHIFT"
+, 
+.br
+.br
+.BI "    NVME_STATUS_TYPE_MASK"
+, 
+.br
+.br
+.BI "    NVME_STATUS_TYPE_NVME"
+, 
+.br
+.br
+.BI "    NVME_STATUS_TYPE_MI"
+
+};
+.SH Constants
+.IP "NVME_STATUS_TYPE_SHIFT" 12
+shift value for status bits
+.IP "NVME_STATUS_TYPE_MASK" 12
+mask value for status bits
+.IP "NVME_STATUS_TYPE_NVME" 12
+NVMe command status value, typically from CDW3
+.IP "NVME_STATUS_TYPE_MI" 12
+NVMe-MI header status
+.SH "Description"
+
+The nvme_* api returns an int, with negative values indicating an internal
+or syscall error, zero signifying success, positive values representing
+the NVMe status.
+
+That latter case (the NVMe status) may represent status values from
+different parts of the transport/controller/etc, and are at most 16 bits of
+data. So, we use the most-significant 3 bits of the signed int to indicate
+which type of status this is.
index 02c5c666018554c0fed65e96b25043e3a47b5bcb..3313701dc5709acf8c657c6d2355f77090516b97 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_streams_directive_params" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_streams_directive_params" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_streams_directive_params \- Streams Directive - Return Parameters Data Structure
 .SH SYNOPSIS
index 13a9a05cf39cd80ee340adee394a6d6c4b0df2a3..df9c96dcecaa13ea9c214cdc46e659d77a70e319 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_streams_directive_status" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_streams_directive_status" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_streams_directive_status \- Streams Directive - Get Status Data Structure
 .SH SYNOPSIS
index c71ab37d6ecc3b2bdc1341539fff09af8ab6da33..f507a8cf2c6518de1b37e7286b399e8c1124a8c6 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_submit_admin_passthru" 9 "nvme_submit_admin_passthru" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_submit_admin_passthru" 9 "nvme_submit_admin_passthru" "October 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_admin_passthru64.2 b/doc/man/nvme_submit_admin_passthru64.2
new file mode 100644 (file)
index 0000000..730eef3
--- /dev/null
@@ -0,0 +1,20 @@
+.TH "nvme_submit_admin_passthru64" 9 "nvme_submit_admin_passthru64" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_submit_admin_passthru64 \- Submit a 64-bit nvme passthrough admin command
+.SH SYNOPSIS
+.B "int" nvme_submit_admin_passthru64
+.BI "(int fd "  ","
+.BI "struct nvme_passthru_cmd64 *cmd "  ","
+.BI "__u64 *result "  ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "cmd" 12
+The nvme admin command to send
+.IP "result" 12
+Optional field to return the result from the CQE DW0-1
+.SH "DESCRIPTION"
+Uses NVME_IOCTL_ADMIN64_CMD for the ioctl request.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index db6107cb35c51154e386f48c7ddb060392499baf..bacbe3e010ab7c405619e2998e5a1f265ebc2653 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_submit_io_passthru" 9 "nvme_submit_io_passthru" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_submit_io_passthru" 9 "nvme_submit_io_passthru" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_submit_io_passthru \- Submit an nvme passthrough command
 .SH SYNOPSIS
diff --git a/doc/man/nvme_submit_io_passthru64.2 b/doc/man/nvme_submit_io_passthru64.2
new file mode 100644 (file)
index 0000000..3d77f57
--- /dev/null
@@ -0,0 +1,20 @@
+.TH "nvme_submit_io_passthru64" 9 "nvme_submit_io_passthru64" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_submit_io_passthru64 \- Submit a 64-bit nvme passthrough command
+.SH SYNOPSIS
+.B "int" nvme_submit_io_passthru64
+.BI "(int fd "  ","
+.BI "struct nvme_passthru_cmd64 *cmd "  ","
+.BI "__u64 *result "  ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "cmd" 12
+The nvme io command to send
+.IP "result" 12
+Optional field to return the result from the CQE DW0-1
+.SH "DESCRIPTION"
+Uses NVME_IOCTL_IO64_CMD for the ioctl request.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.
index 2b65b0fea3ce80a1993b27ed8492de6b5f853fd5..79322585b2d2d82ca023226535acff7d284aa0e9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsys_filter" 9 "nvme_subsys_filter" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsys_filter" 9 "nvme_subsys_filter" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsys_filter \- Filter for subsystems
 .SH SYNOPSIS
index 191994c566e484f06b20756b4b472d4fb1b749ca..dcfe0c8227bea2977656116e2760299e8c042b50 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_subsys_type" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_subsys_type" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_subsys_type \- Type of the NVM subsystem.
 .SH SYNOPSIS
index 5b252af5d57f92df0eed7602f2e6d9c69b6afff2..d87bb62e3f446ef778a6e5b361e8129328c8c44f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_first_ctrl" 9 "nvme_subsystem_first_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_first_ctrl" 9 "nvme_subsystem_first_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_first_ctrl \- First ctrl iterator
 .SH SYNOPSIS
index f85fa5b8c557148c6a98f57b5a779a6460920fec..ac30d574f3986924c9b45914f75ec34f9b4abfab 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_first_ns" 9 "nvme_subsystem_first_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_first_ns" 9 "nvme_subsystem_first_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_first_ns \- Start namespace iterator
 .SH SYNOPSIS
index b4d6d52c9c07628ded6ba64989ea0058dbf754fc..7b695c9e26af5c90777326fb8a20e0103f362832 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_for_each_ctrl" 9 "nvme_subsystem_for_each_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_for_each_ctrl" 9 "nvme_subsystem_for_each_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_for_each_ctrl \- Traverse controllers
 .SH SYNOPSIS
index da1b352fbc7ff1e32bd74156d87daf3d42d4ac11..4bfde84b477bfe9dc14f01420b5cfe13c40a7b7b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_for_each_ctrl_safe" 9 "nvme_subsystem_for_each_ctrl_safe" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_for_each_ctrl_safe" 9 "nvme_subsystem_for_each_ctrl_safe" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_for_each_ctrl_safe \- Traverse controllers
 .SH SYNOPSIS
index e20050743279694ed7904278bb752f417928936e..f5d210f53a3dedd2ccdc73a5be768dcf1f5af2e7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_for_each_ns" 9 "nvme_subsystem_for_each_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_for_each_ns" 9 "nvme_subsystem_for_each_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_for_each_ns \- Traverse namespaces
 .SH SYNOPSIS
index fbba9084f602ae94aac6bffba174b14ff593cdbf..19e24805e768a972c37d0449686615376554b0aa 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_for_each_ns_safe" 9 "nvme_subsystem_for_each_ns_safe" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_for_each_ns_safe" 9 "nvme_subsystem_for_each_ns_safe" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_for_each_ns_safe \- Traverse namespaces
 .SH SYNOPSIS
index 503f1490eef5eeccd9af89ec6a2fab890f0e1d50..79e7e95043d5e2cda559efd848665235d32526e8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_get_host" 9 "nvme_subsystem_get_host" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_host" 9 "nvme_subsystem_get_host" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_get_host \- Returns nvme_host_t object
 .SH SYNOPSIS
index 4bbe8bbbce23e9c3c5a7a53d30a8ad36d90c3df4..b0138e83cbaec4e1e23caa44cdd1df3ba4651d0c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_get_name" 9 "nvme_subsystem_get_name" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_name" 9 "nvme_subsystem_get_name" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_get_name \- sysfs name of an nvme_subsystem_t object
 .SH SYNOPSIS
index a8390adc6b1133a8935afc12be9d07aa497be3ee..e3cd0ec2d933eab61dc657c7e43acdfdf8c1d9f8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_get_nqn" 9 "nvme_subsystem_get_nqn" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_nqn" 9 "nvme_subsystem_get_nqn" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_get_nqn \- Retrieve NQN from subsystem
 .SH SYNOPSIS
index 001ff2f939c661db548d02c30eeef0973cd5dc28..9e28b43d3f987a61e5df37eb751dbdb4cd84e9fb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_get_sysfs_dir" 9 "nvme_subsystem_get_sysfs_dir" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_sysfs_dir" 9 "nvme_subsystem_get_sysfs_dir" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_get_sysfs_dir \- sysfs directory of an nvme_subsystem_t object
 .SH SYNOPSIS
index f1b76a61343a38d8b9c5c49d520770fce1850f86..766819f73891b44d2a99cace1aec466c0635e0dc 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_get_type" 9 "nvme_subsystem_get_type" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_get_type" 9 "nvme_subsystem_get_type" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_get_type \- Returns the type of a subsystem
 .SH SYNOPSIS
index 957eda7beb6365cf1cf94a52672c901391b835d2..ad850baa3668f98ede724ac193cd43adfb4a6e62 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_lookup_namespace" 9 "nvme_subsystem_lookup_namespace" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_lookup_namespace" 9 "nvme_subsystem_lookup_namespace" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_lookup_namespace \- lookup namespace by NSID
 .SH SYNOPSIS
index 009fbfd95e86140afa42c3c14f4b785ffa1edd40..8a2d2dcd6849b6910f6bac930b21baf8f001386a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_next_ctrl" 9 "nvme_subsystem_next_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_next_ctrl" 9 "nvme_subsystem_next_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_next_ctrl \- Next ctrl iterator
 .SH SYNOPSIS
index 3ba119d4194f1ba9adbe312ca8a53a33194677c5..9ac9d1479b7267553e2c5cefc1ba28f5468bf84e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_next_ns" 9 "nvme_subsystem_next_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_next_ns" 9 "nvme_subsystem_next_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_next_ns \- Next namespace iterator
 .SH SYNOPSIS
index 2ba72458a528a556cf3f4032cfeca0d716ca77d5..5e5fb99b21e4e8ea4c7e7c72a8f37af1150ec349 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_subsystem_reset" 9 "nvme_subsystem_reset" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_subsystem_reset" 9 "nvme_subsystem_reset" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_subsystem_reset \- Initiate a subsystem reset
 .SH SYNOPSIS
index 8734c4a589a22694599e2142f65419b4e2735705..2f904db0520287e73db85711e7c5b2bfdae7d2c7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_supported_cap_config_list_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_supported_cap_config_list_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_supported_cap_config_list_log \- Supported Capacity Configuration list log page
 .SH SYNOPSIS
index 1c70a23651fc744d9282d5463de1719abe970bda..1e083d52d6ccc808737cf368740600942212b29c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_supported_log_pages" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_supported_log_pages" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_supported_log_pages \- Supported Log Pages - Log
 .SH SYNOPSIS
index 8249f3a6a7dd67c194130b4ab5d1d47e66f3a442..447f110c890f7ef6ec4ed1a765d52d68f21961a2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_telemetry_da" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_telemetry_da" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_telemetry_da \- Telemetry Log Data Area
 .SH SYNOPSIS
index 73c8991983f936cde158dc92ff29e119cddab9c3..56e47ca01b87d4ef732745c221399319e54734b8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_telemetry_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_telemetry_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_telemetry_log \- Retrieve internal data specific to the manufacturer.
 .SH SYNOPSIS
index 99d25d1499629672940be275eddfefd58d1e158c..69b9b0863a8f848b917dbb6025c4164956bb5cad 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_thermal_exc_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_thermal_exc_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_thermal_exc_event \- Thermal Excursion Event Data
 .SH SYNOPSIS
index 7798a4bdc601582e38863d850af37aaa0d6c101d..648ab3cf4c0c0641bff6b5bfbf3f3d4a0c24bdbe 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_time_stamp_change_event" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_time_stamp_change_event" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_time_stamp_change_event \- Timestamp Change Event
 .SH SYNOPSIS
index 7cd659021ac473f9047e4a19c01c650d44be0a1a..6811763664903e9f0c58d92dde80dc6fbabd284a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_timestamp" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_timestamp" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_timestamp \- Timestamp - Data Structure for Get Features
 .SH SYNOPSIS
index c7bcc5ce9e04886242ede911192db80f50e90c1f..444fac2a7a8f9999bb30dc5fed28b769504e68eb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_unlink_ctrl" 9 "nvme_unlink_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_unlink_ctrl" 9 "nvme_unlink_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_unlink_ctrl \- Unlink controller
 .SH SYNOPSIS
index 25d9968c9265dc8901c6fb661c3bf7a4656ac736..fe7614a032084aae72ad3e651b0de9e7f5365d06 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_update_config" 9 "nvme_update_config" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_update_config" 9 "nvme_update_config" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_update_config \- Update JSON configuration
 .SH SYNOPSIS
index f3ca0bccda74a5ff7f2addf002c9eff6e6ed257d..76c70a2db1ae01edc4da802420054e1e16be1f8c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_uring_cmd" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_uring_cmd" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_uring_cmd \- nvme uring command structure
 .SH SYNOPSIS
index 29f0f43d7a75720ad14522e86ec4bda9690411f3..3bab7588d645e0da3778c822e5c23614f6c2c429 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_verify" 9 "nvme_verify" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_verify" 9 "nvme_verify" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_verify \- Send an nvme verify command
 .SH SYNOPSIS
index 7a91abacf1b45a76cf8e34f6f71a3b7d21faabb6..dcf837fd0242455ef60da861ae115ddd30d5d806 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_version" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_version" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_version \- Selector for version to be returned by @nvme_get_version
 .SH SYNOPSIS
index 407a98e951011f0c271fc903d5b5a04e5917f267..0fe6da000a5ad018ab959e2b2b49db07ac0caedf 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_virt_mgmt_act" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_virt_mgmt_act" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_virt_mgmt_act \- Virtualization Management - Action
 .SH SYNOPSIS
index 4200bfb0434729d491494722bc80215d56f6e5b5..31c0996c469fba4c21012771b7876433dc44f25a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_virt_mgmt_rt" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_virt_mgmt_rt" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_virt_mgmt_rt \- Virtualization Management - Resource Type
 .SH SYNOPSIS
index c69b40e35c13b9f72be868e63c5adf7365a9b56f..ccce5d0d1905f268801dc9155c7bbf6109c8b33b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_virtual_mgmt" 9 "nvme_virtual_mgmt" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_virtual_mgmt" 9 "nvme_virtual_mgmt" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_virtual_mgmt \- Virtualization resource management
 .SH SYNOPSIS
index 19d27b7e6154a7b34b1319f1b6b157f66381c86d..82b7f4623687931c6c55edb59465373e714441c7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_write" 9 "nvme_write" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_write" 9 "nvme_write" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_write \- Submit an nvme user write command
 .SH SYNOPSIS
index aadb4c1390578b1bcd7d636ca1200a82c699a570..2c4ff91eea5c69eee762d885e0b6b3b764a1d365 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_write_uncorrectable" 9 "nvme_write_uncorrectable" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_write_uncorrectable" 9 "nvme_write_uncorrectable" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_write_uncorrectable \- Submit an nvme write uncorrectable command
 .SH SYNOPSIS
index dc1c4db13572edd059d24c9f68c6cc05f1fc3c17..0a8a31e235d7bf2e3e492479077e8f4d99989a00 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_write_zeros" 9 "nvme_write_zeros" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_write_zeros" 9 "nvme_write_zeros" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_write_zeros \- Submit an nvme write zeroes command
 .SH SYNOPSIS
index 21b907fa6a294308aa13df9af139de79e1bc6501..8c053aaba5896fdce7a780c930e7a49ee144b62b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_zns_append" 9 "nvme_zns_append" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_zns_append" 9 "nvme_zns_append" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_zns_append \- Append data to a zone
 .SH SYNOPSIS
index 4a7d395745760ad8dd3a84056d267cd86a109ae1..532d6c8df991299f9eb82ca53e1a1da3ac1a9a51 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_zns_changed_zone_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zns_changed_zone_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_zns_changed_zone_log \- ZNS Changed Zone List log
 .SH SYNOPSIS
index 8f3dc140e6cfac44c56fec3d85da8b5e7d3e1873..61c6faf7e7036e5ea34d57cb5c3599b151275c0b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_zns_desc" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zns_desc" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_zns_desc \- Zone Descriptor Data Structure
 .SH SYNOPSIS
index 66e03b98e22865f6f7c54f7c060401a34c79dc3b..9435814c7f63e6154f75a803b58b90d4506ebf5a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_zns_id_ctrl" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zns_id_ctrl" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_zns_id_ctrl \- I/O Command Set Specific Identify Controller Data Structure for the Zoned Namespace Command Set
 .SH SYNOPSIS
index 3e21cc6dae5f29d814e90a288189ad3bf6413934..ca31bcf879952b8467432c1db0af4c2e5349ad64 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_zns_id_ns" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zns_id_ns" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_zns_id_ns \- Zoned Namespace Command Set Specific Identify Namespace Data Structure
 .SH SYNOPSIS
index b68cb5e2ea6481783d22639703656b3724686aa8..b7aa90826e819ef1cb28fdd184d600cb0e38e36c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_zns_identify_ctrl" 9 "nvme_zns_identify_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_zns_identify_ctrl" 9 "nvme_zns_identify_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_zns_identify_ctrl \- ZNS identify controller data
 .SH SYNOPSIS
index 8caa6e93951281569b462835ac203ea171c268e6..b021df3018f2cb05baf27a2a22ed254d03f7cec2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_zns_identify_ns" 9 "nvme_zns_identify_ns" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_zns_identify_ns" 9 "nvme_zns_identify_ns" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_zns_identify_ns \- ZNS identify namespace data
 .SH SYNOPSIS
index fb6352f1e0055ca1d167f54282f6b46fa0844a35..fe25273d1f21f0a310e96df897904c4a49c45624 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_zns_lbafe" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zns_lbafe" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_zns_lbafe \- LBA Format Extension Data Structure
 .SH SYNOPSIS
index 9e4ac1f77c892f7e7f1cdd6d8ba3cd094b1245eb..bd0caf62e83f8e7519cef00434309542c83aea1f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_zns_mgmt_recv" 9 "nvme_zns_mgmt_recv" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_zns_mgmt_recv" 9 "nvme_zns_mgmt_recv" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_zns_mgmt_recv \- ZNS management receive command
 .SH SYNOPSIS
index 597f1383172d3dab841a8425637cb28ef75a59d8..017f44f6ef7a78b48bb24829a20fecd1d980cdeb 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_zns_mgmt_send" 9 "nvme_zns_mgmt_send" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_zns_mgmt_send" 9 "nvme_zns_mgmt_send" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_zns_mgmt_send \- ZNS management send command
 .SH SYNOPSIS
index 499ea149b6a21875ec4a6e8b2e3419ca9089d62f..b6f249b2906c027253a6fd8720f255c7c99c4d87 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_zns_recv_action" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_recv_action" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_zns_recv_action \- Zone Management Receive - Zone Receive Action Specific Features
 .SH SYNOPSIS
index 3ba8f37688f3d62dfc988c2a91d5bb9a86f26fc0..1396181dff94476abe0081bf2d76a4defbee6d3e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_zns_report_options" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_report_options" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_zns_report_options \- Zone Management Receive - Zone Receive Action Specific Field
 .SH SYNOPSIS
index 430c59767511e8f8629d289a15ed77f6f22357d7..51f8cd2d3a7dc1e7de16b1d791d361ef485d2e4f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvme_zns_report_zones" 9 "nvme_zns_report_zones" "August 2022" "libnvme API manual" LINUX
+.TH "nvme_zns_report_zones" 9 "nvme_zns_report_zones" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvme_zns_report_zones \- Return the list of zones
 .SH SYNOPSIS
index ebec78c8a173737c40a80f26ba8468b2115aaca8..073fa8bbef3dd5198395642e92e8201d1aa86072 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_zns_send_action" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_send_action" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_zns_send_action \- Zone Management Send - Zone Send Action
 .SH SYNOPSIS
index 6f8466aeeba1f4d1cf55d4c95aa0395feb7f5059..c2d387a8328996c279169b714ae42192f3ccca09 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_zns_za" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_za" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_zns_za \- Zone Descriptor Data Structure
 .SH SYNOPSIS
index f8f0820bcca1a91b50d6db4a4c2f340092488e13..05fd4f08bb0d3af162409a123917ae2f88ddfa2e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_zns_zs" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_zs" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_zns_zs \- Zone Descriptor Data Structure - Zone State
 .SH SYNOPSIS
index 04439cde3809a25a7f8f7744bf115792e78d0157..3051a4fa231959268e2033117aa64cbe2718a633 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvme_zns_zt" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvme_zns_zt" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvme_zns_zt \- Zone Descriptor Data Structure - Zone Type
 .SH SYNOPSIS
index d0a7b4f259e2193e785784f079a66ed98bf91388..98cedb1e94ea025342211eab1fdd6e8c06d126d1 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvme_zone_report" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvme_zone_report" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvme_zone_report \- Report Zones Data Structure
 .SH SYNOPSIS
index 02d5dfeb5dbc9c1a520790ead1d00c6df08cd173..4da7085c6b32efebee378f5712021ccd0fa60c9a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_add_ctrl" 9 "nvmf_add_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_add_ctrl" 9 "nvmf_add_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_add_ctrl \- Connect a controller and update topology
 .SH SYNOPSIS
index 0dae370ad2bde59a0206e1615a23ee4332d7fe32..d55d386221c1a0f3cb3bd30b64e8d9e761368436 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_addr_family" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_addr_family" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvmf_addr_family \- Address Family codes for Discovery Log Page entry ADRFAM field
 .SH SYNOPSIS
index 27afa56ad1c5f29df6ed19c001c3ae6528e2a7d2..f0e7dad07b5fbdfa1ad6b44fa99a79f2353e5c27 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_adrfam_str" 9 "nvmf_adrfam_str" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_adrfam_str" 9 "nvmf_adrfam_str" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_adrfam_str \- Decode ADRFAM field
 .SH SYNOPSIS
index ab5fea1557280744c1b48b90da0afdd70f1f9038..b65cc08e5406a2e261758969c17142052e204f09 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_cms_str" 9 "nvmf_cms_str" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_cms_str" 9 "nvmf_cms_str" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_cms_str \- Decode RDMA connection management service field
 .SH SYNOPSIS
index 073ddb14b3e6f5f31a4a5924b2544705c11df185..c32c2a3f06c420c33920b9bfade2209a69870afe 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvmf_connect_data" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_connect_data" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvmf_connect_data \- Data payload for the 'connect' command
 .SH SYNOPSIS
index fca4624200f35cdde0a869d47a58b571e3b5977d..5f72f368d4f1e3465f362221dd2de5f4505a6b70 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_connect_disc_entry" 9 "nvmf_connect_disc_entry" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_connect_disc_entry" 9 "nvmf_connect_disc_entry" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_connect_disc_entry \- Connect controller based on the discovery log page entry
 .SH SYNOPSIS
index bfdcdf0901098654ade472b3f55651c3d5423501..bd4855c54755e950a237714e7a1460e3a44b0b0f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_default_config" 9 "nvmf_default_config" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_default_config" 9 "nvmf_default_config" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_default_config \- Default values for fabrics configuration
 .SH SYNOPSIS
index fa717ad17bb05ca38418dcce6be67af679a08f99..28a56fa1d03353377855f3647885f13aff168305 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvmf_dim_data" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_dim_data" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvmf_dim_data \- Discovery Information Management (DIM) - Data
 .SH SYNOPSIS
index f50057c959c3a998c260dc0a9dcacc689da735cd..1babab1b3f697304ba2ba40ed3b504516df3b265 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_dim_entfmt" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_dim_entfmt" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvmf_dim_entfmt \- Discovery Information Management Entry Format
 .SH SYNOPSIS
index cf5026e76c0ff8bb43d4aa109c60a6144fa1b404..fd2f7602de19a11a9a2cfa55a6b3dae92f45adc7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_dim_etype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_dim_etype" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvmf_dim_etype \- Discovery Information Management Entity Type
 .SH SYNOPSIS
index f63d15468583b011850b6aed21e6aa0e7d7e25e7..605c81a27a3ae4a5f6b4799651ecd808bf4608de 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_dim_tas" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_dim_tas" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvmf_dim_tas \- Discovery Information Management Task
 .SH SYNOPSIS
index 1b55e059bab4d172ff0bb3c4a7396fc0b19b8fc5..ffa91a8e1f183bc331906e10c0eb82c6591467a3 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_disc_eflags" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_disc_eflags" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvmf_disc_eflags \- Discovery Log Page entry flags.
 .SH SYNOPSIS
index 88dc362d3e96666310fb046ff5f8636fcb26bf4c..0faa8b8c04d0472d2ea20cee22e395e81352bac7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvmf_disc_log_entry" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_disc_log_entry" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvmf_disc_log_entry \- Discovery Log Page entry
 .SH SYNOPSIS
index 345a17fb0a128f43c29652ae4005e2c267c1d4e2..912644b57157ca5c6a3af5dec3bc6ef26edf2aff 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvmf_discovery_log" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_discovery_log" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvmf_discovery_log \- Discovery Log Page (Log Identifier 70h)
 .SH SYNOPSIS
index 849962d23889bb490d8718cc268d00fb0c94e3f9..11b9e142abf42dcce23ddef9cce16a17c4f8907c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_eflags_str" 9 "nvmf_eflags_str" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_eflags_str" 9 "nvmf_eflags_str" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_eflags_str \- Decode EFLAGS field
 .SH SYNOPSIS
index a71fd3b23302a4636b6d2f0f488dd93309c8794d..b7f9783adc93c482a62ef693b194a785cef9c913 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_exat_len" 9 "nvmf_exat_len" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_exat_len" 9 "nvmf_exat_len" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_exat_len \- Return length rounded up by 4
 .SH SYNOPSIS
index 972de972eb0b83c5c5126e6bd8b6515512839dc6..881ec363da11d0a12a23356242987e7c1015da77 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_exattype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_exattype" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvmf_exattype \- Extended Attribute Type
 .SH SYNOPSIS
index 2cb4009b03a6d858c7ae34286b2ca7b696bb9bca..d94b835cf0cde711457d28cf25915489f4a9330e 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvmf_ext_attr" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_ext_attr" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvmf_ext_attr \- Extended Attribute (EXAT)
 .SH SYNOPSIS
index 13fa255fa294c870605be32e54c2710c471b2c81..c8c1de6f04fcffd2e5784c9b7f6de70df4294333 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "struct nvmf_ext_die" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "struct nvmf_ext_die" "October 2022" "API Manual" LINUX
 .SH NAME
 struct nvmf_ext_die \- Extended Discovery Information Entry (DIE)
 .SH SYNOPSIS
index 87a3c7c446d9311494448dafe0e7f6885bcd17a8..715fe10edf3de2944a43410b7f095e181386816c 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_get_discovery_log" 9 "nvmf_get_discovery_log" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_get_discovery_log \- Return the discovery log page
 .SH SYNOPSIS
@@ -8,10 +8,15 @@ nvmf_get_discovery_log \- Return the discovery log page
 .BI "int max_retries "  ");"
 .SH ARGUMENTS
 .IP "c" 12
-Discover controller to use
+Discovery controller to use
 .IP "logp" 12
 Pointer to the log page to be returned
 .IP "max_retries" 12
-maximum number of log page entries to be returned
+Number of retries in case of failure
+.SH "DESCRIPTION"
+The memory allocated for the log page and returned in \fIlogp\fP
+must be freed by the caller using \fBfree\fP.
+.SH "NOTE"
+Consider using \fBnvmf_get_discovery_wargs\fP instead.
 .SH "RETURN"
 0 on success; on failure -1 is returned and errno is set
diff --git a/doc/man/nvmf_get_discovery_wargs.2 b/doc/man/nvmf_get_discovery_wargs.2
new file mode 100644 (file)
index 0000000..b07c2f9
--- /dev/null
@@ -0,0 +1,20 @@
+.TH "nvmf_get_discovery_wargs" 9 "nvmf_get_discovery_wargs" "October 2022" "libnvme API manual" LINUX
+.SH NAME
+nvmf_get_discovery_wargs \- Get the discovery log page with args
+.SH SYNOPSIS
+.B "struct nvmf_discovery_log *" nvmf_get_discovery_wargs
+.BI "(struct nvme_get_discovery_args *args "  ");"
+.SH ARGUMENTS
+.IP "args" 12
+Argument structure
+.SH "DESCRIPTION"
+This function is similar to \fBnvmf_get_discovery_log\fP, but
+takes an extensible \fIargs\fP parameter. \fIargs\fP provides more
+options than \fBnvmf_get_discovery_log\fP.
+
+This function performs a get discovery log page (DLP) command
+and returns the DLP. The memory allocated for the returned
+DLP must be freed by the caller using \fBfree\fP.
+.SH "RETURN"
+Pointer to the discovery log page (to be freed). NULL
+on failure and errno is set.
index 7e13626c789efafbf97ee8796f52d774908a8cea..65d6942371f11540715c276a9abc19316b64f1a0 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_hostid_from_file" 9 "nvmf_hostid_from_file" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_hostid_from_file" 9 "nvmf_hostid_from_file" "October 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
index 987aa453359387b442944d7c30f7b2c096478cfe..eaa970113e997b15fab53964b0ab9bf57b4dd591 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_hostnqn_from_file" 9 "nvmf_hostnqn_from_file" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_hostnqn_from_file" 9 "nvmf_hostnqn_from_file" "October 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
index c17f5c0d7a05d0c45dcb4538b04503694ca17734..b7a77d6929d3dd4b1f192431bf6310b34c1b05e8 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_hostnqn_generate" 9 "nvmf_hostnqn_generate" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_hostnqn_generate" 9 "nvmf_hostnqn_generate" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_hostnqn_generate \- Generate a machine specific host nqn
 .SH SYNOPSIS
diff --git a/doc/man/nvmf_log_discovery_lid_support.2 b/doc/man/nvmf_log_discovery_lid_support.2
new file mode 100644 (file)
index 0000000..e5bd563
--- /dev/null
@@ -0,0 +1,30 @@
+.TH "libnvme" 9 "enum nvmf_log_discovery_lid_support" "October 2022" "API Manual" LINUX
+.SH NAME
+enum nvmf_log_discovery_lid_support \- Discovery log specific support
+.SH SYNOPSIS
+enum nvmf_log_discovery_lid_support {
+.br
+.BI "    NVMF_LOG_DISC_LID_NONE"
+, 
+.br
+.br
+.BI "    NVMF_LOG_DISC_LID_EXTDLPES"
+, 
+.br
+.br
+.BI "    NVMF_LOG_DISC_LID_PLEOS"
+, 
+.br
+.br
+.BI "    NVMF_LOG_DISC_LID_ALLSUBES"
+
+};
+.SH Constants
+.IP "NVMF_LOG_DISC_LID_NONE" 12
+None
+.IP "NVMF_LOG_DISC_LID_EXTDLPES" 12
+Extended Discovery Log Page Entries Supported
+.IP "NVMF_LOG_DISC_LID_PLEOS" 12
+Port Local Entries Only Supported
+.IP "NVMF_LOG_DISC_LID_ALLSUBES" 12
+All NVM Subsystem Entries Supported
diff --git a/doc/man/nvmf_log_discovery_lsp.2 b/doc/man/nvmf_log_discovery_lsp.2
new file mode 100644 (file)
index 0000000..ec2ede1
--- /dev/null
@@ -0,0 +1,30 @@
+.TH "libnvme" 9 "enum nvmf_log_discovery_lsp" "October 2022" "API Manual" LINUX
+.SH NAME
+enum nvmf_log_discovery_lsp \- Discovery log specific field
+.SH SYNOPSIS
+enum nvmf_log_discovery_lsp {
+.br
+.BI "    NVMF_LOG_DISC_LSP_NONE"
+, 
+.br
+.br
+.BI "    NVMF_LOG_DISC_LSP_EXTDLPE"
+, 
+.br
+.br
+.BI "    NVMF_LOG_DISC_LSP_PLEO"
+, 
+.br
+.br
+.BI "    NVMF_LOG_DISC_LSP_ALLSUBE"
+
+};
+.SH Constants
+.IP "NVMF_LOG_DISC_LSP_NONE" 12
+None
+.IP "NVMF_LOG_DISC_LSP_EXTDLPE" 12
+Extended Discovery Log Page Entries
+.IP "NVMF_LOG_DISC_LSP_PLEO" 12
+Port Local Entries Only
+.IP "NVMF_LOG_DISC_LSP_ALLSUBE" 12
+All NVM Subsystem Entries
index a90ace30b189ca8a2d3a800425d251d9818e1ff0..615d854022076b4847f9d2259141f32ff996801b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_prtype_str" 9 "nvmf_prtype_str" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_prtype_str" 9 "nvmf_prtype_str" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_prtype_str \- Decode RDMA Provider type field
 .SH SYNOPSIS
index 2464ea98653fbc5a2512e394654cba04c8943d5b..b9dea4f3889110e7fc7b6aa8566b736162ba9f2f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_qptype_str" 9 "nvmf_qptype_str" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_qptype_str" 9 "nvmf_qptype_str" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_qptype_str \- Decode RDMA QP Service type field
 .SH SYNOPSIS
index aee4c0636d541aca3553f1984659bcd8b50249d9..e619dca962819f98c3037ed88bd3bdff6cda9bcd 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_rdma_cms" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_rdma_cms" "October 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
index 7782bab161e49adc5466838a4ac403273788a66b..db1bd066414320beeb8d7f1a1616da97ca4b9295 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_rdma_prtype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_rdma_prtype" "October 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
index 43cd99be7a7832ebdc9c2983a3d853c7ce885e9f..06406672e42fc57ec7393344cfbc6c401dcbc606 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_rdma_qptype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_rdma_qptype" "October 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
index b43239138719a5cb3d62f07bde0890697b3925b4..12cab3f0859e3feae9938b2e2e8c3ef290e1c204 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_register_ctrl" 9 "nvmf_register_ctrl" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_register_ctrl" 9 "nvmf_register_ctrl" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_register_ctrl \- Perform registration task with a DC
 .SH SYNOPSIS
index 8c5fd350be229e6a4d385d84b6e8482df2acf2de..bd9bc9b8a57bb25e714b29f4da34d4d9fba550d9 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_sectype_str" 9 "nvmf_sectype_str" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_sectype_str" 9 "nvmf_sectype_str" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_sectype_str \- Decode SECTYPE field
 .SH SYNOPSIS
index 157f5facc29176e832021954445665e6c7a70f61..13ad38c9deb4f7d149c5cfe49092704a1ae301b2 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_subtype_str" 9 "nvmf_subtype_str" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_subtype_str" 9 "nvmf_subtype_str" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_subtype_str \- Decode SUBTYPE field
 .SH SYNOPSIS
index 0322e248610e0a74b299ad65575a7222201c6a74..ca97e55e574cfe7d943867eff47239e40329f18b 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_tcp_sectype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_tcp_sectype" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvmf_tcp_sectype \- Transport Specific Address Subtype Definition for NVMe/TCP Transport
 .SH SYNOPSIS
index 697085673a4d4d0908ec8d68f2132d45581e5e5a..f881ecc5467e9ead0bfc1121bbfc757485637f57 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_treq" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_treq" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvmf_treq \- Transport Requirements codes for Discovery Log Page entry TREQ field
 .SH SYNOPSIS
index 9816c253db48d7a60cff6a5fdd49c5706b115c08..8a2b9545be52e86e8f97567d2e8d0e96b6082685 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_treq_str" 9 "nvmf_treq_str" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_treq_str" 9 "nvmf_treq_str" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_treq_str \- Decode TREQ field
 .SH SYNOPSIS
index d3017716e618a1d6eb1856061e72a1aaf71fb9f9..9db82f19d2769ed276d4a4abe6945f1648099754 100644 (file)
@@ -1,4 +1,4 @@
-.TH "libnvme" 9 "enum nvmf_trtype" "August 2022" "API Manual" LINUX
+.TH "libnvme" 9 "enum nvmf_trtype" "October 2022" "API Manual" LINUX
 .SH NAME
 enum nvmf_trtype \- Transport Type codes for Discovery Log Page entry TRTYPE field
 .SH SYNOPSIS
index 9e323a8ed5a135c212218130126c9e054194e150..53a04c4f3821b5551ccf53967713c492ec94fad7 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_trtype_str" 9 "nvmf_trtype_str" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_trtype_str" 9 "nvmf_trtype_str" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_trtype_str \- Decode TRTYPE field
 .SH SYNOPSIS
index 2edbc2c191946b2c05da38e698111d7f7408179c..cc84868eceb8feafd95b0c56c17e0c577a7a0e4f 100644 (file)
@@ -1,4 +1,4 @@
-.TH "nvmf_update_config" 9 "nvmf_update_config" "August 2022" "libnvme API manual" LINUX
+.TH "nvmf_update_config" 9 "nvmf_update_config" "October 2022" "libnvme API manual" LINUX
 .SH NAME
 nvmf_update_config \- Update fabrics configuration values
 .SH SYNOPSIS
index b89dc0f04eddd0596368f5dad8bc23de6c6903f6..f0249f0988e7b8d54f85e450092eb2b89a78f7b1 100644 (file)
@@ -322,19 +322,94 @@ into the topology using **h** as parent.
 **Parameters**
 
 ``nvme_ctrl_t c``
-  Discover controller to use
+  Discovery controller to use
 
 ``struct nvmf_discovery_log **logp``
   Pointer to the log page to be returned
 
 ``int max_retries``
-  maximum number of log page entries to be returned
+  Number of retries in case of failure
+
+**Description**
+
+The memory allocated for the log page and returned in **logp**
+must be freed by the caller using free().
+
+**Note**
+
+Consider using nvmf_get_discovery_wargs() instead.
 
 **Return**
 
 0 on success; on failure -1 is returned and errno is set
 
 
+
+
+.. c:struct:: nvme_get_discovery_args
+
+   Arguments for nvmf_get_discovery_wargs()
+
+**Definition**
+
+::
+
+  struct nvme_get_discovery_args {
+    nvme_ctrl_t c;
+    int args_size;
+    int max_retries;
+    __u32 *result;
+    __u32 timeout;
+    __u8 lsp;
+  };
+
+**Members**
+
+``c``
+  Discovery controller
+
+``args_size``
+  Length of the structure
+
+``max_retries``
+  Number of retries in case of failure
+
+``result``
+  The command completion result from CQE dword0
+
+``timeout``
+  Timeout in ms (default: NVME_DEFAULT_IOCTL_TIMEOUT)
+
+``lsp``
+  Log specific field (See enum nvmf_log_discovery_lsp)
+
+
+
+.. c:function:: struct nvmf_discovery_log * nvmf_get_discovery_wargs (struct nvme_get_discovery_args *args)
+
+   Get the discovery log page with args
+
+**Parameters**
+
+``struct nvme_get_discovery_args *args``
+  Argument structure
+
+**Description**
+
+This function is similar to nvmf_get_discovery_log(), but
+takes an extensible **args** parameter. **args** provides more
+options than nvmf_get_discovery_log().
+
+This function performs a get discovery log page (DLP) command
+and returns the DLP. The memory allocated for the returned
+DLP must be freed by the caller using free().
+
+**Return**
+
+Pointer to the discovery log page (to be freed). NULL
+on failure and errno is set.
+
+
 .. c:function:: char * nvmf_hostnqn_generate ()
 
    Generate a machine specific host nqn
index 0da53a58c43ccef49780a1b8df7a6385f5833699..3eaa20c91095dedfd8a1269cb9c2d8395370f2df 100644 (file)
@@ -578,6 +578,28 @@ This is the generic response format with the three doublewords of completion
 queue data, plus optional response data.
 
 
+.. c:function:: const char * nvme_mi_status_to_string (int status)
+
+   return a string representation of the MI status.
+
+**Parameters**
+
+``int status``
+  MI response status
+
+**Description**
+
+Gives a string description of **status**, as per section 4.1.2 of the NVMe-MI
+spec. The status value should be of type NVME_STATUS_MI, and extracted
+from the return value using nvme_status_get_value().
+
+Returned string is const, and should not be free()ed.
+
+**Return**
+
+A string representing the status value
+
+
 .. c:function:: nvme_root_t nvme_mi_create_root (FILE *fp, int log_level)
 
    Create top-level MI (root) handle.
@@ -949,7 +971,8 @@ See: :c:type:`nvme_mi_for_each_ctrl`
 
 **Return**
 
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
 
 
 .. c:function:: nvme_mi_ctrl_t nvme_mi_init_ctrl (nvme_mi_ep_t ep, __u16 ctrl_id)
@@ -1027,7 +1050,8 @@ NVMe version information. See :c:type:`struct nvme_mi_read_nvm_ss_info <nvme_mi_
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_read_mi_data_port (nvme_mi_ep_t ep, __u8 portid, struct nvme_mi_read_port_info *p)
@@ -1055,7 +1079,8 @@ See :c:type:`struct nvme_mi_read_port_info <nvme_mi_read_port_info>`.
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_read_mi_data_ctrl_list (nvme_mi_ep_t ep, __u8 start_ctrlid, struct nvme_ctrl_list *list)
@@ -1082,7 +1107,8 @@ See :c:type:`struct nvme_ctrl_list <nvme_ctrl_list>`.
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_read_mi_data_ctrl (nvme_mi_ep_t ep, __u16 ctrl_id, struct nvme_mi_read_ctrl_info *ctrl)
@@ -1109,7 +1135,8 @@ See :c:type:`struct nvme_mi_read_ctrl_info <nvme_mi_read_ctrl_info>`.
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_subsystem_health_status_poll (nvme_mi_ep_t ep, bool clear, struct nvme_mi_nvm_ss_health_status *nshds)
@@ -1137,7 +1164,8 @@ See :c:type:`struct nvme_mi_nvm_ss_health_status <nvme_mi_nvm_ss_health_status>`
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_config_get (nvme_mi_ep_t ep, __u32 dw0, __u32 dw1, __u32 *nmresp)
@@ -1172,7 +1200,8 @@ See :c:type:`enum nvme_mi_config_id <nvme_mi_config_id>` for identifiers.
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_config_set (nvme_mi_ep_t ep, __u32 dw0, __u32 dw1)
@@ -1200,7 +1229,8 @@ See :c:type:`enum nvme_mi_config_id <nvme_mi_config_id>` for identifiers.
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_config_get_smbus_freq (nvme_mi_ep_t ep, __u8 port, enum nvme_mi_config_smbus_freq *freq)
@@ -1226,7 +1256,8 @@ frequency
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_config_set_smbus_freq (nvme_mi_ep_t ep, __u8 port, enum nvme_mi_config_smbus_freq freq)
@@ -1254,7 +1285,8 @@ for the port.
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_config_set_health_status_change (nvme_mi_ep_t ep, __u32 mask)
@@ -1281,7 +1313,8 @@ values in **mask**.
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_config_get_mctp_mtu (nvme_mi_ep_t ep, __u8 port, __u16 *mtu)
@@ -1312,7 +1345,8 @@ may not accept MCTP messages larger than the configured MTU.
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_mi_config_set_mctp_mtu (nvme_mi_ep_t ep, __u8 port, __u16 mtu)
@@ -1342,7 +1376,8 @@ interface(s) to match.
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_admin_xfer (nvme_mi_ctrl_t ctrl, struct nvme_mi_admin_req_hdr *admin_req, size_t req_data_size, struct nvme_mi_admin_resp_hdr *admin_resp, off_t resp_data_offset, size_t *resp_data_size)
@@ -1388,7 +1423,8 @@ See: :c:type:`struct nvme_mi_admin_req_hdr <nvme_mi_admin_req_hdr>` and :c:type:
 
 **Return**
 
-0 on success, non-zero on failure.
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise..
 
 
 .. c:function:: int nvme_mi_admin_identify_partial (nvme_mi_ctrl_t ctrl, struct nvme_identify_args *args, off_t offset, size_t size)
@@ -1429,7 +1465,8 @@ See: :c:type:`struct nvme_identify_args <nvme_identify_args>`
 
 **Return**
 
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
 
 
 .. c:function:: int nvme_mi_admin_identify (nvme_mi_ctrl_t ctrl, struct nvme_identify_args *args)
@@ -1457,7 +1494,8 @@ See: :c:type:`struct nvme_identify_args <nvme_identify_args>`
 
 **Return**
 
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
 
 
 .. c:function:: int nvme_mi_admin_identify_cns_nsid (nvme_mi_ctrl_t ctrl, enum nvme_identify_cns cns, __u32 nsid, void *data)
@@ -1491,7 +1529,86 @@ controller) is not a full :c:type:`NVME_IDENTIFY_DATA_SIZE`.
 
 **Return**
 
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_identify_ns (nvme_mi_ctrl_t ctrl, __u32 nsid, struct nvme_id_ns *ns)
+
+   Perform an Admin identify command for a namespace
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to process identify command
+
+``__u32 nsid``
+  namespace ID
+
+``struct nvme_id_ns *ns``
+  Namespace identification to populate
+
+**Description**
+
+Perform an Identify (namespace) command, setting the namespace id data
+in **ns**. The namespace is expected to active and allocated.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_identify_ns_descs (nvme_mi_ctrl_t ctrl, __u32 nsid, struct nvme_ns_id_desc *descs)
+
+   Perform an Admin identify Namespace Identification Descriptor list command for a namespace
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to process identify command
+
+``__u32 nsid``
+  Namespace ID
+
+``struct nvme_ns_id_desc *descs``
+  Namespace Identification Descriptor list to populate
+
+**Description**
+
+Perform an Identify namespace identification description list command,
+setting the namespace identification description list in **descs**
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_identify_allocated_ns (nvme_mi_ctrl_t ctrl, __u32 nsid, struct nvme_id_ns *ns)
+
+   Perform an Admin identify command for an allocated namespace
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to process identify command
+
+``__u32 nsid``
+  namespace ID
+
+``struct nvme_id_ns *ns``
+  Namespace identification to populate
+
+**Description**
+
+Perform an Identify (namespace) command, setting the namespace id data
+in **ns**.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
 
 
 .. c:function:: int nvme_mi_admin_identify_ctrl (nvme_mi_ctrl_t ctrl, struct nvme_id_ctrl *id)
@@ -1519,7 +1636,8 @@ See: :c:type:`struct nvme_id_ctrl <nvme_id_ctrl>`
 
 **Return**
 
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
 
 
 .. c:function:: int nvme_mi_admin_identify_ctrl_list (nvme_mi_ctrl_t ctrl, __u16 cntid, struct nvme_ctrl_list *list)
@@ -1550,6 +1668,174 @@ See: :c:type:`struct nvme_ctrl_list <nvme_ctrl_list>`
 
 **Return**
 
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_identify_nsid_ctrl_list (nvme_mi_ctrl_t ctrl, __u32 nsid, __u16 cntid, struct nvme_ctrl_list *list)
+
+   Perform an Admin identify for a controller list with specific namespace ID
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to process identify command
+
+``__u32 nsid``
+  Namespace identifier
+
+``__u16 cntid``
+  Controller ID to specify list start
+
+``struct nvme_ctrl_list *list``
+  List data to populate
+
+**Description**
+
+Perform an Identify command, for the controller list for **nsid**, starting
+with IDs greater than or equal to **cntid**.
+
+Will return an error if the length of the response data (from the
+controller) is not a full :c:type:`NVME_IDENTIFY_DATA_SIZE`, so **id** will be
+fully populated on success.
+
+See: :c:type:`struct nvme_ctrl_list <nvme_ctrl_list>`
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_identify_allocated_ns_list (nvme_mi_ctrl_t ctrl, __u32 nsid, struct nvme_ns_list *list)
+
+   Perform an Admin identify for an allocated namespace list
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to process identify command
+
+``__u32 nsid``
+  Namespace ID to specify list start
+
+``struct nvme_ns_list *list``
+  List data to populate
+
+**Description**
+
+Perform an Identify command, for the allocated namespace list starting with
+IDs greater than or equal to **nsid**. Specify :c:type:`NVME_NSID_NONE` for the start
+of the list.
+
+Will return an error if the length of the response data (from the
+controller) is not a full :c:type:`NVME_IDENTIFY_DATA_SIZE`, so **list** will be
+be fully populated on success.
+
+See: :c:type:`struct nvme_ns_list <nvme_ns_list>`
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_identify_active_ns_list (nvme_mi_ctrl_t ctrl, __u32 nsid, struct nvme_ns_list *list)
+
+   Perform an Admin identify for an active namespace list
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to process identify command
+
+``__u32 nsid``
+  Namespace ID to specify list start
+
+``struct nvme_ns_list *list``
+  List data to populate
+
+**Description**
+
+Perform an Identify command, for the active namespace list starting with
+IDs greater than or equal to **nsid**. Specify :c:type:`NVME_NSID_NONE` for the start
+of the list.
+
+Will return an error if the length of the response data (from the
+controller) is not a full :c:type:`NVME_IDENTIFY_DATA_SIZE`, so **list** will be
+be fully populated on success.
+
+See: :c:type:`struct nvme_ns_list <nvme_ns_list>`
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_identify_primary_ctrl (nvme_mi_ctrl_t ctrl, __u16 cntid, struct nvme_primary_ctrl_cap *cap)
+
+   Perform an Admin identify for primary controller capabilities data structure.
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to process identify command
+
+``__u16 cntid``
+  Controller ID to specify
+
+``struct nvme_primary_ctrl_cap *cap``
+  Primary Controller Capabilities data structure to populate
+
+**Description**
+
+Perform an Identify command to get the Primary Controller Capabilities data
+for the controller specified by **cntid**
+
+Will return an error if the length of the response data (from the
+controller) is not a full :c:type:`NVME_IDENTIFY_DATA_SIZE`, so **cap** will be
+be fully populated on success.
+
+See: :c:type:`struct nvme_primary_ctrl_cap <nvme_primary_ctrl_cap>`
+
+**Return**
+
+0 on success, non-zero on failure
+
+
+.. c:function:: int nvme_mi_admin_identify_secondary_ctrl_list (nvme_mi_ctrl_t ctrl, __u32 nsid, __u16 cntid, struct nvme_secondary_ctrl_list *list)
+
+   Perform an Admin identify for a secondary controller list.
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to process identify command
+
+``__u32 nsid``
+  Namespace ID to specify list start
+
+``__u16 cntid``
+  Controller ID to specify list start
+
+``struct nvme_secondary_ctrl_list *list``
+  List data to populate
+
+**Description**
+
+Perform an Identify command, for the secondary controllers associated with
+the current primary controller. Only entries with IDs greater than or
+equal to **cntid** are returned.
+
+Will return an error if the length of the response data (from the
+controller) is not a full :c:type:`NVME_IDENTIFY_DATA_SIZE`, so **list** will be
+be fully populated on success.
+
+See: :c:type:`struct nvme_secondary_ctrl_list <nvme_secondary_ctrl_list>`
+
+**Return**
+
 0 on success, non-zero on failure
 
 
@@ -1579,64 +1865,1195 @@ See: :c:type:`struct nvme_get_log_args <nvme_get_log_args>`
 
 **Return**
 
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
 
 
-.. c:function:: int nvme_mi_admin_security_send (nvme_mi_ctrl_t ctrl, struct nvme_security_send_args *args)
+.. c:function:: int nvme_mi_admin_get_nsid_log (nvme_mi_ctrl_t ctrl, bool rae, enum nvme_cmd_get_log_lid lid, __u32 nsid, __u32 len, void *log)
 
-   Perform a Security Send command on a controller.
+   Helper for Get Log Page functions
 
 **Parameters**
 
 ``nvme_mi_ctrl_t ctrl``
-  Controller to send command to
+  Controller to query
 
-``struct nvme_security_send_args *args``
-  Security Send command arguments
+``bool rae``
+  Retain Asynchronous Events
 
-**Description**
+``enum nvme_cmd_get_log_lid lid``
+  Log identifier
 
-Performs a Security Send Admin command as specified by **args**. Response data
-is stored in **args->data**, which should be a buffer of **args->data_len** bytes.
-Resulting data length is stored in **args->data_len** on successful
-command completion.
+``__u32 nsid``
+  Namespace ID
 
-Security Send data length should not be greater than 4096 bytes to
-comply with specification limits.
+``__u32 len``
+  length of log buffer
 
-See: :c:type:`struct nvme_get_log_args <nvme_get_log_args>`
+``void *log``
+  pointer for resulting log data
+
+**Description**
+
+Performs a Get Log Page Admin command for a specific log ID **lid** and
+namespace ID **nsid**. Log data is expected to be **len** bytes, and is stored
+in **log** on success. The **rae** flag is passed as-is to the Get Log Page
+command, and is specific to the Log Page requested.
 
 **Return**
 
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
 
 
-.. c:function:: int nvme_mi_admin_security_recv (nvme_mi_ctrl_t ctrl, struct nvme_security_receive_args *args)
+.. c:function:: int nvme_mi_admin_get_log_simple (nvme_mi_ctrl_t ctrl, enum nvme_cmd_get_log_lid lid, __u32 len, void *log)
 
-   Perform a Security Receive command on a controller.
+   Helper for Get Log Page functions with no NSID or RAE requirements
 
 **Parameters**
 
 ``nvme_mi_ctrl_t ctrl``
-  Controller to send command to
+  Controller to query
 
-``struct nvme_security_receive_args *args``
-  Security Receive command arguments
+``enum nvme_cmd_get_log_lid lid``
+  Log identifier
+
+``__u32 len``
+  length of log buffer
+
+``void *log``
+  pointer for resulting log data
 
 **Description**
 
-Performs a Security Receive Admin command as specified by **args**. Response
-data is stored in **args->data**, which should be a buffer of **args->data_len**
-bytes. Resulting data length is stored in **args->data_len** on successful
-command completion.
+Performs a Get Log Page Admin command for a specific log ID **lid**, using
+NVME_NSID_ALL for the namespace identifier, and rae set to false.
 
-Security Receive data length should not be greater than 4096 bytes to
-comply with specification limits.
+**Return**
 
-See: :c:type:`struct nvme_get_log_args <nvme_get_log_args>`
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_supported_log_pages (nvme_mi_ctrl_t ctrl, bool rae, struct nvme_supported_log_pages *log)
+
+   Retrieve nmve supported log pages
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``struct nvme_supported_log_pages *log``
+  Array of LID supported and Effects data structures
 
 **Return**
 
-0 on success, non-zero on failure
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_error (nvme_mi_ctrl_t ctrl, unsigned int nr_entries, bool rae, struct nvme_error_log_page *err_log)
+
+   Retrieve nvme error log
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``unsigned int nr_entries``
+  Number of error log entries allocated
+
+``bool rae``
+  Retain asynchronous events
+
+``struct nvme_error_log_page *err_log``
+  Array of error logs of size 'entries'
+
+**Description**
+
+This log page describes extended error information for a command that
+completed with error, or may report an error that is not specific to a
+particular command.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_smart (nvme_mi_ctrl_t ctrl, __u32 nsid, bool rae, struct nvme_smart_log *smart_log)
+
+   Retrieve nvme smart log
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``__u32 nsid``
+  Optional namespace identifier
+
+``bool rae``
+  Retain asynchronous events
+
+``struct nvme_smart_log *smart_log``
+  User address to store the smart log
+
+**Description**
+
+This log page provides SMART and general health information. The information
+provided is over the life of the controller and is retained across power
+cycles. To request the controller log page, the namespace identifier
+specified is FFFFFFFFh. The controller may also support requesting the log
+page on a per namespace basis, as indicated by bit 0 of the LPA field in the
+Identify Controller data structure.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_fw_slot (nvme_mi_ctrl_t ctrl, bool rae, struct nvme_firmware_slot *fw_log)
+
+   Retrieves the controller firmware log
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``struct nvme_firmware_slot *fw_log``
+  User address to store the log page
+
+**Description**
+
+This log page describes the firmware revision stored in each firmware slot
+supported. The firmware revision is indicated as an ASCII string. The log
+page also indicates the active slot number.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_changed_ns_list (nvme_mi_ctrl_t ctrl, bool rae, struct nvme_ns_list *ns_log)
+
+   Retrieve namespace changed list
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``struct nvme_ns_list *ns_log``
+  User address to store the log page
+
+**Description**
+
+This log page describes namespaces attached to this controller that have
+changed since the last time the namespace was identified, been added, or
+deleted.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_cmd_effects (nvme_mi_ctrl_t ctrl, enum nvme_csi csi, struct nvme_cmd_effects_log *effects_log)
+
+   Retrieve nvme command effects log
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``enum nvme_csi csi``
+  Command Set Identifier
+
+``struct nvme_cmd_effects_log *effects_log``
+  User address to store the effects log
+
+**Description**
+
+This log page describes the commands that the controller supports and the
+effects of those commands on the state of the NVM subsystem.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_device_self_test (nvme_mi_ctrl_t ctrl, struct nvme_self_test_log *log)
+
+   Retrieve the device self test log
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``struct nvme_self_test_log *log``
+  Userspace address of the log payload
+
+**Description**
+
+The log page indicates the status of an in progress self test and the
+percent complete of that operation, and the results of the previous 20
+self-test operations.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_create_telemetry_host (nvme_mi_ctrl_t ctrl, struct nvme_telemetry_log *log)
+
+   Create host telemetry log
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``struct nvme_telemetry_log *log``
+  Userspace address of the log payload
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_telemetry_host (nvme_mi_ctrl_t ctrl, __u64 offset, __u32 len, void *log)
+
+   Get Telemetry Host-Initiated log page
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``__u64 offset``
+  Offset into the telemetry data
+
+``__u32 len``
+  Length of provided user buffer to hold the log data in bytes
+
+``void *log``
+  User address for log page data
+
+**Description**
+
+Retrieves the Telemetry Host-Initiated log page at the requested offset
+using the previously existing capture.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_telemetry_ctrl (nvme_mi_ctrl_t ctrl, bool rae, __u64 offset, __u32 len, void *log)
+
+   Get Telemetry Controller-Initiated log page
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``__u64 offset``
+  Offset into the telemetry data
+
+``__u32 len``
+  Length of provided user buffer to hold the log data in bytes
+
+``void *log``
+  User address for log page data
+
+**Description**
+
+Retrieves the Telemetry Controller-Initiated log page at the requested offset
+using the previously existing capture.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_endurance_group (nvme_mi_ctrl_t ctrl, __u16 endgid, struct nvme_endurance_group_log *log)
+
+   Get Endurance Group log
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``__u16 endgid``
+  Starting group identifier to return in the list
+
+``struct nvme_endurance_group_log *log``
+  User address to store the endurance log
+
+**Description**
+
+This log page indicates if an Endurance Group Event has occurred for a
+particular Endurance Group. If an Endurance Group Event has occurred, the
+details of the particular event are included in the Endurance Group
+Information log page for that Endurance Group. An asynchronous event is
+generated when an entry for an Endurance Group is newly added to this log
+page.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_predictable_lat_nvmset (nvme_mi_ctrl_t ctrl, __u16 nvmsetid, struct nvme_nvmset_predictable_lat_log *log)
+
+   Predictable Latency Per NVM Set
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``__u16 nvmsetid``
+  NVM set id
+
+``struct nvme_nvmset_predictable_lat_log *log``
+  User address to store the predictable latency log
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_predictable_lat_event (nvme_mi_ctrl_t ctrl, bool rae, __u32 offset, __u32 len, void *log)
+
+   Retrieve Predictable Latency Event Aggregate Log Page
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``__u32 offset``
+  Offset into the predictable latency event
+
+``__u32 len``
+  Length of provided user buffer to hold the log data in bytes
+
+``void *log``
+  User address for log page data
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_ana (nvme_mi_ctrl_t ctrl, enum nvme_log_ana_lsp lsp, bool rae, __u64 offset, __u32 len, void *log)
+
+   Retrieve Asymmetric Namespace Access log page
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``enum nvme_log_ana_lsp lsp``
+  Log specific, see :c:type:`enum nvme_get_log_ana_lsp <nvme_get_log_ana_lsp>`
+
+``bool rae``
+  Retain asynchronous events
+
+``__u64 offset``
+  Offset to the start of the log page
+
+``__u32 len``
+  The allocated length of the log page
+
+``void *log``
+  User address to store the ana log
+
+**Description**
+
+This log consists of a header describing the log and descriptors containing
+the asymmetric namespace access information for ANA Groups that contain
+namespaces that are attached to the controller processing the command.
+
+See :c:type:`struct nvme_ana_rsp_hdr <nvme_ana_rsp_hdr>` for the definition of the returned structure.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_ana_groups (nvme_mi_ctrl_t ctrl, bool rae, __u32 len, struct nvme_ana_group_desc *log)
+
+   Retrieve Asymmetric Namespace Access groups only log page
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``__u32 len``
+  The allocated length of the log page
+
+``struct nvme_ana_group_desc *log``
+  User address to store the ana group log
+
+**Description**
+
+See :c:type:`struct nvme_ana_group_desc <nvme_ana_group_desc>` for the definition of the returned structure.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_lba_status (nvme_mi_ctrl_t ctrl, bool rae, __u64 offset, __u32 len, void *log)
+
+   Retrieve LBA Status
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``__u64 offset``
+  Offset to the start of the log page
+
+``__u32 len``
+  The allocated length of the log page
+
+``void *log``
+  User address to store the log page
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_endurance_grp_evt (nvme_mi_ctrl_t ctrl, bool rae, __u32 offset, __u32 len, void *log)
+
+   Retrieve Rotational Media Information
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``__u32 offset``
+  Offset to the start of the log page
+
+``__u32 len``
+  The allocated length of the log page
+
+``void *log``
+  User address to store the log page
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_fid_supported_effects (nvme_mi_ctrl_t ctrl, bool rae, struct nvme_fid_supported_effects_log *log)
+
+   Retrieve Feature Identifiers Supported and Effects
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``struct nvme_fid_supported_effects_log *log``
+  FID Supported and Effects data structure
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_mi_cmd_supported_effects (nvme_mi_ctrl_t ctrl, bool rae, struct nvme_mi_cmd_supported_effects_log *log)
+
+   displays the MI Commands Supported by the controller
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``struct nvme_mi_cmd_supported_effects_log *log``
+  MI Command Supported and Effects data structure
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_boot_partition (nvme_mi_ctrl_t ctrl, bool rae, __u8 lsp, __u32 len, struct nvme_boot_partition *part)
+
+   Retrieve Boot Partition
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``__u8 lsp``
+  The log specified field of LID
+
+``__u32 len``
+  The allocated size, minimum
+  struct nvme_boot_partition
+
+``struct nvme_boot_partition *part``
+  User address to store the log page
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_discovery (nvme_mi_ctrl_t ctrl, bool rae, __u32 offset, __u32 len, void *log)
+
+   Retrieve Discovery log page
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``__u32 offset``
+  Offset of this log to retrieve
+
+``__u32 len``
+  The allocated size for this portion of the log
+
+``void *log``
+  User address to store the discovery log
+
+**Description**
+
+Supported only by fabrics discovery controllers, returning discovery
+records.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_media_unit_stat (nvme_mi_ctrl_t ctrl, __u16 domid, struct nvme_media_unit_stat_log *mus)
+
+   Retrieve Media Unit Status
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``__u16 domid``
+  Domain Identifier selection, if supported
+
+``struct nvme_media_unit_stat_log *mus``
+  User address to store the Media Unit statistics log
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_support_cap_config_list (nvme_mi_ctrl_t ctrl, __u16 domid, struct nvme_supported_cap_config_list_log *cap)
+
+   Retrieve Supported Capacity Configuration List
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``__u16 domid``
+  Domain Identifier selection, if supported
+
+``struct nvme_supported_cap_config_list_log *cap``
+  User address to store supported capabilities config list
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_reservation (nvme_mi_ctrl_t ctrl, bool rae, struct nvme_resv_notification_log *log)
+
+   Retrieve Reservation Notification
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``struct nvme_resv_notification_log *log``
+  User address to store the reservation log
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_sanitize (nvme_mi_ctrl_t ctrl, bool rae, struct nvme_sanitize_log_page *log)
+
+   Retrieve Sanitize Status
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``bool rae``
+  Retain asynchronous events
+
+``struct nvme_sanitize_log_page *log``
+  User address to store the sanitize log
+
+**Description**
+
+The Sanitize Status log page reports sanitize operation time estimates and
+information about the most recent sanitize operation.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_zns_changed_zones (nvme_mi_ctrl_t ctrl, __u32 nsid, bool rae, struct nvme_zns_changed_zone_log *log)
+
+   Retrieve list of zones that have changed
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``__u32 nsid``
+  Namespace ID
+
+``bool rae``
+  Retain asynchronous events
+
+``struct nvme_zns_changed_zone_log *log``
+  User address to store the changed zone log
+
+**Description**
+
+The list of zones that have changed state due to an exceptional event.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_log_persistent_event (nvme_mi_ctrl_t ctrl, enum nvme_pevent_log_action action, __u32 size, void *pevent_log)
+
+   Retrieve Persistent Event Log
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to query
+
+``enum nvme_pevent_log_action action``
+  Action the controller should take during processing this command
+
+``__u32 size``
+  Size of **pevent_log**
+
+``void *pevent_log``
+  User address to store the persistent event log
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_security_send (nvme_mi_ctrl_t ctrl, struct nvme_security_send_args *args)
+
+   Perform a Security Send command on a controller.
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``struct nvme_security_send_args *args``
+  Security Send command arguments
+
+**Description**
+
+Performs a Security Send Admin command as specified by **args**. Response data
+is stored in **args->data**, which should be a buffer of **args->data_len** bytes.
+Resulting data length is stored in **args->data_len** on successful
+command completion.
+
+Security Send data length should not be greater than 4096 bytes to
+comply with specification limits.
+
+See: :c:type:`struct nvme_get_log_args <nvme_get_log_args>`
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_security_recv (nvme_mi_ctrl_t ctrl, struct nvme_security_receive_args *args)
+
+   Perform a Security Receive command on a controller.
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``struct nvme_security_receive_args *args``
+  Security Receive command arguments
+
+**Description**
+
+Performs a Security Receive Admin command as specified by **args**. Response
+data is stored in **args->data**, which should be a buffer of **args->data_len**
+bytes. Resulting data length is stored in **args->data_len** on successful
+command completion.
+
+Security Receive data length should not be greater than 4096 bytes to
+comply with specification limits.
+
+See: :c:type:`struct nvme_get_log_args <nvme_get_log_args>`
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_features (nvme_mi_ctrl_t ctrl, struct nvme_get_features_args *args)
+
+   Perform a Get Feature command on a controller
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``struct nvme_get_features_args *args``
+  Get Features command arguments
+
+**Description**
+
+Performs a Get Features Admin command as specified by **args**. Returned
+feature data will be stored in **args->result** and **args->data**, depending
+on the specification of the feature itself; most features do not return
+additional data. See section 5.27.1 of the NVMe spec (v2.0b) for
+feature-specific information.
+
+On success, **args->data_len** will be updated with the actual data length
+received.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_features_data (nvme_mi_ctrl_t ctrl, enum nvme_features_id fid, __u32 nsid, __u32 data_len, void *data, __u32 *result)
+
+   Helper function for :c:type:`nvme_mi_admin_get_features`()
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``enum nvme_features_id fid``
+  Feature identifier
+
+``__u32 nsid``
+  Namespace ID, if applicable for **fid**
+
+``__u32 data_len``
+  Length of feature data, if applicable for **fid**, in bytes
+
+``void *data``
+  User address of feature data, if applicable
+
+``__u32 *result``
+  The command completion result from CQE dword0
+
+**Description**
+
+Helper for optionally features that optionally return data, using the
+SEL_CURRENT selector value.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_get_features_simple (nvme_mi_ctrl_t ctrl, enum nvme_features_id fid, __u32 nsid, __u32 *result)
+
+   Get a simple feature value with no data
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``enum nvme_features_id fid``
+  Feature identifier
+
+``__u32 nsid``
+  Namespace id, if required by **fid**
+
+``__u32 *result``
+  output feature data
+
+
+.. c:function:: int nvme_mi_admin_set_features (nvme_mi_ctrl_t ctrl, struct nvme_set_features_args *args)
+
+   Perform a Set Features command on a controller
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``struct nvme_set_features_args *args``
+  Set Features command arguments
+
+**Description**
+
+Performs a Set Features Admin command as specified by **args**. Result
+data will be stored in **args->result**.
+on the specification of the feature itself; most features do not return
+additional data. See section 5.27.1 of the NVMe spec (v2.0b) for
+feature-specific information.
+
+On success, **args->data_len** will be updated with the actual data length
+received.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_ns_mgmt (nvme_mi_ctrl_t ctrl, struct nvme_ns_mgmt_args *args)
+
+   Issue a Namespace Management command
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``struct nvme_ns_mgmt_args *args``
+  Namespace management command arguments
+
+**Description**
+
+Issues a Namespace Management command to **ctrl**, with arguments specified
+from **args**.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_ns_mgmt_create (nvme_mi_ctrl_t ctrl, struct nvme_id_ns *ns, __u8 csi, __u32 *nsid)
+
+   Helper for Namespace Management Create command
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``struct nvme_id_ns *ns``
+  New namespace parameters
+
+``__u8 csi``
+  Command Set Identifier for new NS
+
+``__u32 *nsid``
+  Set to new namespace ID on create
+
+**Description**
+
+Issues a Namespace Management (Create) command to **ctrl**, to create a
+new namespace specified by **ns**, using command set **csi**. On success,
+the new namespace ID will be written to **nsid**.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_ns_mgmt_delete (nvme_mi_ctrl_t ctrl, __u32 nsid)
+
+   Helper for Namespace Management Delete command
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``__u32 nsid``
+  Namespace ID to delete
+
+**Description**
+
+Issues a Namespace Management (Delete) command to **ctrl**, to delete the
+namespace with id **nsid**.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_ns_attach (nvme_mi_ctrl_t ctrl, struct nvme_ns_attach_args *args)
+
+   Attach or detach namespace to controller(s)
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``struct nvme_ns_attach_args *args``
+  Namespace Attach command arguments
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_ns_attach_ctrls (nvme_mi_ctrl_t ctrl, __u32 nsid, struct nvme_ctrl_list *ctrlist)
+
+   Attach namespace to controllers
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``__u32 nsid``
+  Namespace ID to attach
+
+``struct nvme_ctrl_list *ctrlist``
+  Controller list to modify attachment state of nsid
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_ns_detach_ctrls (nvme_mi_ctrl_t ctrl, __u32 nsid, struct nvme_ctrl_list *ctrlist)
+
+   Detach namespace from controllers
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``__u32 nsid``
+  Namespace ID to detach
+
+``struct nvme_ctrl_list *ctrlist``
+  Controller list to modify attachment state of nsid
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_fw_download (nvme_mi_ctrl_t ctrl, struct nvme_fw_download_args *args)
+
+   Download part or all of a firmware image to the controller
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send firmware data to
+
+``struct nvme_fw_download_args *args``
+  :c:type:`struct nvme_fw_download_args <nvme_fw_download_args>` argument structure
+
+**Description**
+
+The Firmware Image Download command downloads all or a portion of an image
+for a future update to the controller. The Firmware Image Download command
+downloads a new image (in whole or in part) to the controller.
+
+The image may be constructed of multiple pieces that are individually
+downloaded with separate Firmware Image Download commands. Each Firmware
+Image Download command includes a Dword Offset and Number of Dwords that
+specify a dword range.
+
+The new firmware image is not activated as part of the Firmware Image
+Download command. Use the nvme_mi_admin_fw_commit() to activate a newly
+downloaded image.
+
+**Return**
+
+0 on success, non-zero on failure
+
+
+.. c:function:: int nvme_mi_admin_fw_commit (nvme_mi_ctrl_t ctrl, struct nvme_fw_commit_args *args)
+
+   Commit firmware using the specified action
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send firmware data to
+
+``struct nvme_fw_commit_args *args``
+  :c:type:`struct nvme_fw_download_args <nvme_fw_download_args>` argument structure
+
+**Description**
+
+The Firmware Commit command modifies the firmware image or Boot Partitions.
+
+**Return**
+
+0 on success, non-zero on failure
+
+
+.. c:function:: int nvme_mi_admin_format_nvm (nvme_mi_ctrl_t ctrl, struct nvme_format_nvm_args *args)
+
+   Format NVMe namespace
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``struct nvme_format_nvm_args *args``
+  Format NVM command arguments
+
+**Description**
+
+Perform a low-level format to set the LBA data & metadata size. May destroy
+data & metadata on the specified namespaces
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
+
+
+.. c:function:: int nvme_mi_admin_sanitize_nvm (nvme_mi_ctrl_t ctrl, struct nvme_sanitize_nvm_args *args)
+
+   Start a subsystem Sanitize operation
+
+**Parameters**
+
+``nvme_mi_ctrl_t ctrl``
+  Controller to send command to
+
+``struct nvme_sanitize_nvm_args *args``
+  Sanitize command arguments
+
+**Description**
+
+A sanitize operation alters all user data in the NVM subsystem such that
+recovery of any previous user data from any cache, the non-volatile media,
+or any Controller Memory Buffer is not possible.
+
+The Sanitize command starts a sanitize operation or to recover from a
+previously failed sanitize operation. The sanitize operation types that may
+be supported are Block Erase, Crypto Erase, and Overwrite. All sanitize
+operations are processed in the background, i.e., completion of the sanitize
+command does not indicate completion of the sanitize operation.
+
+**Return**
+
+The nvme command status if a response was received (see
+:c:type:`enum nvme_status_field <nvme_status_field>`) or -1 with errno set otherwise.
 
 
index 233446484cc9bd56d088c5b8478a333862fc33d4..d6f270de5ad8cc4f44a47f1debe2bb380b9b8818 100644 (file)
@@ -824,7 +824,7 @@ A pointer to the 64-bit eui
 A pointer to the 128-bit nguid
 
 
-.. c:function:: void nvme_ns_get_uuid (nvme_ns_t n, uuid_t out)
+.. c:function:: void nvme_ns_get_uuid (nvme_ns_t n, unsigned char out[NVME_UUID_LEN])
 
    UUID of a namespace
 
@@ -833,7 +833,7 @@ A pointer to the 128-bit nguid
 ``nvme_ns_t n``
   Namespace instance
 
-``uuid_t out``
+``unsigned char out[NVME_UUID_LEN]``
   buffer for the UUID
 
 **Description**
@@ -1477,6 +1477,33 @@ Host transport address of **c** (if present)
 Host interface name of **c** (if present)
 
 
+.. c:function:: const char * nvme_ctrl_get_dhchap_host_key (nvme_ctrl_t c)
+
+   Return host key
+
+**Parameters**
+
+``nvme_ctrl_t c``
+  Controller to be checked
+
+**Return**
+
+DH-HMAC-CHAP host key or NULL if not set
+
+
+.. c:function:: void nvme_ctrl_set_dhchap_host_key (nvme_ctrl_t c, const char *key)
+
+   Set host key
+
+**Parameters**
+
+``nvme_ctrl_t c``
+  Host for which the key should be set
+
+``const char *key``
+  DH-HMAC-CHAP Key to set or NULL to clear existing key
+
+
 .. c:function:: const char * nvme_ctrl_get_dhchap_key (nvme_ctrl_t c)
 
    Return controller key
index 43e204908c68c87f7fdbc21de5f57ee56ea74d99..9140821ce0443fd4408bee15c60b2011ebd1daf9 100644 (file)
@@ -7551,6 +7551,48 @@ bytes, in size. This log captures the controller’s internal state.
 
 
 
+.. c:enum:: nvmf_log_discovery_lid_support
+
+   Discovery log specific support
+
+**Constants**
+
+``NVMF_LOG_DISC_LID_NONE``
+  None
+
+``NVMF_LOG_DISC_LID_EXTDLPES``
+  Extended Discovery Log Page Entries Supported
+
+``NVMF_LOG_DISC_LID_PLEOS``
+  Port Local Entries Only Supported
+
+``NVMF_LOG_DISC_LID_ALLSUBES``
+  All NVM Subsystem Entries Supported
+
+
+
+
+.. c:enum:: nvmf_log_discovery_lsp
+
+   Discovery log specific field
+
+**Constants**
+
+``NVMF_LOG_DISC_LSP_NONE``
+  None
+
+``NVMF_LOG_DISC_LSP_EXTDLPE``
+  Extended Discovery Log Page Entries
+
+``NVMF_LOG_DISC_LSP_PLEO``
+  Port Local Entries Only
+
+``NVMF_LOG_DISC_LSP_ALLSUBE``
+  All NVM Subsystem Entries
+
+
+
+
 .. c:struct:: nvmf_discovery_log
 
    Discovery Log Page (Log Identifier 70h)
@@ -9483,6 +9525,88 @@ status code
 
 
 
+.. c:enum:: nvme_status_type
+
+   type encoding for NVMe return values, when represented as an int.
+
+**Constants**
+
+``NVME_STATUS_TYPE_SHIFT``
+  shift value for status bits
+
+``NVME_STATUS_TYPE_MASK``
+  mask value for status bits
+
+``NVME_STATUS_TYPE_NVME``
+  NVMe command status value, typically from CDW3
+
+``NVME_STATUS_TYPE_MI``
+  NVMe-MI header status
+
+**Description**
+
+
+The nvme_* api returns an int, with negative values indicating an internal
+or syscall error, zero signifying success, positive values representing
+the NVMe status.
+
+That latter case (the NVMe status) may represent status values from
+different parts of the transport/controller/etc, and are at most 16 bits of
+data. So, we use the most-significant 3 bits of the signed int to indicate
+which type of status this is.
+
+
+.. c:function:: __u32 nvme_status_get_type (int status)
+
+   extract the type from a nvme_* return value
+
+**Parameters**
+
+``int status``
+  the (non-negative) return value from the NVMe API
+
+**Return**
+
+the type component of the status.
+
+
+.. c:function:: __u32 nvme_status_get_value (int status)
+
+   extract the status value from a nvme_* return value
+
+**Parameters**
+
+``int status``
+  the (non-negative) return value from the NVMe API
+
+**Return**
+
+the value component of the status; the set of values will depend
+on the status type.
+
+
+.. c:function:: __u32 nvme_status_equals (int status, enum nvme_status_type type, unsigned int value)
+
+   helper to check a status against a type and value
+
+**Parameters**
+
+``int status``
+  the (non-negative) return value from the NVMe API
+
+``enum nvme_status_type type``
+  the status type
+
+``unsigned int value``
+  the status value
+
+**Return**
+
+true if **status** is of the specified type and value
+
+
+
+
 .. c:enum:: nvme_admin_opcode
 
    Known NVMe admin opcodes
@@ -10592,6 +10716,27 @@ status code
 
 
 
+.. c:enum:: nvme_data_tfr
+
+   Data transfer direction of the command
+
+**Constants**
+
+``NVME_DATA_TFR_NO_DATA_TFR``
+  No data transfer
+
+``NVME_DATA_TFR_HOST_TO_CTRL``
+  Host to controller
+
+``NVME_DATA_TFR_CTRL_TO_HOST``
+  Controller to host
+
+``NVME_DATA_TFR_BIDIRECTIONAL``
+  Bidirectional
+
+
+
+
 .. c:enum:: nvme_io_opcode
 
    Opcodes for I/O Commands
index 68ac03b55e1c770fb6ecc9dc16ab5dd34c88c590..87ea9455ab04ecee437369d71d49924190370d35 100644 (file)
@@ -246,6 +246,33 @@ otherwise.
 recognize :c:type:`fid`.
 
 
+.. c:function:: int nvme_get_feature_length2 (int fid, __u32 cdw11, enum nvme_data_tfr dir, __u32 *len)
+
+   Retreive the command payload length for a specific feature identifier
+
+**Parameters**
+
+``int fid``
+  Feature identifier, see :c:type:`enum nvme_features_id <nvme_features_id>`.
+
+``__u32 cdw11``
+  The cdw11 value may affect the transfer (only known fid is
+  ``NVME_FEAT_FID_HOST_ID``)
+
+``enum nvme_data_tfr dir``
+  Data transfer direction: false - host to controller, true -
+  controller to host may affect the transfer (only known fid is
+  ``NVME_FEAT_FID_HOST_MEM_BUF``).
+
+``__u32 *len``
+  On success, set to this features payload length in bytes.
+
+**Return**
+
+0 on success, -1 with errno set to EINVAL if the function did not
+recognize :c:type:`fid`.
+
+
 .. c:function:: int nvme_get_directive_receive_length (enum nvme_directive_dtype dtype, enum nvme_directive_receive_doper doper, __u32 *len)
 
    Get directive receive length
@@ -492,3 +519,56 @@ Pointer to the next element in the array.
 Returns version string for known types or else "n/a"
 
 
+.. c:function:: int nvme_uuid_to_string (unsigned char uuid[NVME_UUID_LEN], char *str)
+
+   Return string represenation of encoded UUID
+
+**Parameters**
+
+``unsigned char uuid[NVME_UUID_LEN]``
+  Binary encoded input UUID
+
+``char *str``
+  Output string represenation of UUID
+
+**Return**
+
+Returns error code if type conversion fails.
+
+
+.. c:function:: int nvme_uuid_from_string (const char *str, unsigned char uuid[NVME_UUID_LEN])
+
+   Return encoded UUID represenation of string UUID
+
+**Parameters**
+
+``const char *str``
+  Output string represenation of UUID
+
+``unsigned char uuid[NVME_UUID_LEN]``
+  Binary encoded input UUID
+
+**Return**
+
+Returns error code if type conversion fails.
+
+
+.. c:function:: int nvme_uuid_random (unsigned char uuid[NVME_UUID_LEN])
+
+   Generate random UUID
+
+**Parameters**
+
+``unsigned char uuid[NVME_UUID_LEN]``
+  Generated random UUID
+
+**Description**
+
+Generate random number according
+https://www.rfc-editor.org/rfc/rfc4122#section-4.4
+
+**Return**
+
+Returns error code if generating of random number fails.
+
+