summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_mi_admin_get_log_cmd_effects.2
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:40:20 +0000
commit2dba2525fb35dcfc79aad5bdf6c92e790d69635c (patch)
treeac8ac7d3960922094733bac6d9a5300da7171c56 /doc/man/nvme_mi_admin_get_log_cmd_effects.2
parentInitial commit. (diff)
downloadlibnvme-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_get_log_cmd_effects.2')
-rw-r--r--doc/man/nvme_mi_admin_get_log_cmd_effects.221
1 files changed, 21 insertions, 0 deletions
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
index 0000000..cb30a55
--- /dev/null
+++ b/doc/man/nvme_mi_admin_get_log_cmd_effects.2
@@ -0,0 +1,21 @@
+.TH "nvme_mi_admin_get_log_cmd_effects" 9 "nvme_mi_admin_get_log_cmd_effects" "January 2023" "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.