summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_identify_ctrl.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_identify_ctrl.2')
-rw-r--r--doc/man/nvme_identify_ctrl.219
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/man/nvme_identify_ctrl.2 b/doc/man/nvme_identify_ctrl.2
new file mode 100644
index 0000000..dce2bf1
--- /dev/null
+++ b/doc/man/nvme_identify_ctrl.2
@@ -0,0 +1,19 @@
+.TH "nvme_identify_ctrl" 9 "nvme_identify_ctrl" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_identify_ctrl \- Retrieves nvme identify controller
+.SH SYNOPSIS
+.B "int" nvme_identify_ctrl
+.BI "(int fd " ","
+.BI "struct nvme_id_ctrl *id " ");"
+.SH ARGUMENTS
+.IP "fd" 12
+File descriptor of nvme device
+.IP "id" 12
+User space destination address to transfer the data,
+.SH "DESCRIPTION"
+Sends nvme identify with CNS value NVME_IDENTIFY_CNS_CTRL.
+
+See \fIstruct nvme_id_ctrl\fP for details on the data returned.
+.SH "RETURN"
+The nvme command status if a response was received (see
+\fIenum nvme_status_field\fP) or -1 with errno set otherwise.