summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_submit_admin_passthru64.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-05 18:17:17 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-11-05 18:17:17 +0000
commit0e75b5495117b9888b7a557fab1db40145a9a705 (patch)
treee294b5156b7a85197e4b3192b6fba291a26dd5c6 /doc/man/nvme_submit_admin_passthru64.2
parentAdding upstream version 1.1. (diff)
downloadlibnvme-0e75b5495117b9888b7a557fab1db40145a9a705.tar.xz
libnvme-0e75b5495117b9888b7a557fab1db40145a9a705.zip
Adding upstream version 1.2.upstream/1.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/man/nvme_submit_admin_passthru64.2')
-rw-r--r--doc/man/nvme_submit_admin_passthru64.220
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/man/nvme_submit_admin_passthru64.2 b/doc/man/nvme_submit_admin_passthru64.2
new file mode 100644
index 0000000..730eef3
--- /dev/null
+++ b/doc/man/nvme_submit_admin_passthru64.2
@@ -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.