diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-26 05:25:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2022-07-26 05:34:52 +0000 |
commit | 9ecff41dd11e920286f9be670a0ec3a668371d1d (patch) | |
tree | 89c73ab6742847ca5f12056e6c0dd4ec6bbe79d0 /doc/man/nvme_mi_admin_identify_cns_nsid.2 | |
parent | Adding debian version 1.0-1. (diff) | |
download | libnvme-9ecff41dd11e920286f9be670a0ec3a668371d1d.tar.xz libnvme-9ecff41dd11e920286f9be670a0ec3a668371d1d.zip |
Merging upstream version 1.1~rc0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_mi_admin_identify_cns_nsid.2')
-rw-r--r-- | doc/man/nvme_mi_admin_identify_cns_nsid.2 | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_identify_cns_nsid.2 b/doc/man/nvme_mi_admin_identify_cns_nsid.2 new file mode 100644 index 0000000..c9ebe0a --- /dev/null +++ b/doc/man/nvme_mi_admin_identify_cns_nsid.2 @@ -0,0 +1,29 @@ +.TH "nvme_mi_admin_identify_cns_nsid" 9 "nvme_mi_admin_identify_cns_nsid" "July 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify_cns_nsid \- Perform an Admin identify command using specific CNS/NSID parameters. +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify_cns_nsid +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "enum nvme_identify_cns cns " "," +.BI "__u32 nsid " "," +.BI "void *data " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "cns" 12 +Controller or Namespace Structure, specifying identified object +.IP "nsid" 12 +namespace ID +.IP "data" 12 +buffer for identify data response +.SH "DESCRIPTION" +Perform an Identify command, using the CNS specifier \fIcns\fP, and the +namespace ID \fInsid\fP if required by the CNS type. + +Stores the identify data in \fIdata\fP, which is expected to be a buffer of +\fINVME_IDENTIFY_DATA_SIZE\fP bytes. + +Will return an error if the length of the response data (from the +controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP. +.SH "RETURN" +0 on success, non-zero on failure |