diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:40:20 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-29 04:40:20 +0000 |
commit | 2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch) | |
tree | ac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_mi_admin_identify_partial.2 | |
parent | Initial commit. (diff) | |
download | libnvme-upstream.tar.xz libnvme-upstream.zip |
Adding upstream version 1.3.upstream/1.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_mi_admin_identify_partial.2')
-rw-r--r-- | doc/man/nvme_mi_admin_identify_partial.2 | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/man/nvme_mi_admin_identify_partial.2 b/doc/man/nvme_mi_admin_identify_partial.2 new file mode 100644 index 0000000..027c4f6 --- /dev/null +++ b/doc/man/nvme_mi_admin_identify_partial.2 @@ -0,0 +1,37 @@ +.TH "nvme_mi_admin_identify_partial" 9 "nvme_mi_admin_identify_partial" "January 2023" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify_partial \- Perform an Admin identify command, and retrieve partial response data. +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify_partial +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "struct nvme_identify_args *args " "," +.BI "off_t offset " "," +.BI "size_t size " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "args" 12 +Identify command arguments +.IP "offset" 12 +offset of identify data to retrieve from response +.IP "size" 12 +size of identify data to return +.SH "DESCRIPTION" +Perform an Identify command, using the Identify command parameters in \fIargs\fP. +The \fIoffset\fP and \fIsize\fP arguments allow the caller to retrieve part of +the identify response. See NVMe-MI section 6.2 for the semantics (and some +handy diagrams) of the offset & size parameters. + +Will return an error if the length of the response data (from the controller) +did not match \fIsize\fP. + +Unless you're performing a vendor-unique identify command, You'll probably +want to use one of the identify helpers (nvme_mi_admin_identify, +nvme_mi_admin_identify_cns_nsid, or nvme_mi_admin_identify_<type>) instead +of this. If the type of your identify command is standardized but not +yet supported by libnvme-mi, please contact the maintainers. + +See: \fIstruct nvme_identify_args\fP +.SH "RETURN" +The nvme command status if a response was received (see +\fIenum nvme_status_field\fP) or -1 with errno set otherwise. |