From 0e75b5495117b9888b7a557fab1db40145a9a705 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 5 Nov 2022 19:17:17 +0100 Subject: Adding upstream version 1.2. Signed-off-by: Daniel Baumann --- doc/man/nvme_mi_admin_identify_primary_ctrl.2 | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 doc/man/nvme_mi_admin_identify_primary_ctrl.2 (limited to 'doc/man/nvme_mi_admin_identify_primary_ctrl.2') diff --git a/doc/man/nvme_mi_admin_identify_primary_ctrl.2 b/doc/man/nvme_mi_admin_identify_primary_ctrl.2 new file mode 100644 index 0000000..4c89791 --- /dev/null +++ b/doc/man/nvme_mi_admin_identify_primary_ctrl.2 @@ -0,0 +1,26 @@ +.TH "nvme_mi_admin_identify_primary_ctrl" 9 "nvme_mi_admin_identify_primary_ctrl" "October 2022" "libnvme API manual" LINUX +.SH NAME +nvme_mi_admin_identify_primary_ctrl \- Perform an Admin identify for primary controller capabilities data structure. +.SH SYNOPSIS +.B "int" nvme_mi_admin_identify_primary_ctrl +.BI "(nvme_mi_ctrl_t ctrl " "," +.BI "__u16 cntid " "," +.BI "struct nvme_primary_ctrl_cap *cap " ");" +.SH ARGUMENTS +.IP "ctrl" 12 +Controller to process identify command +.IP "cntid" 12 +Controller ID to specify +.IP "cap" 12 +Primary Controller Capabilities data structure to populate +.SH "DESCRIPTION" +Perform an Identify command to get the Primary Controller Capabilities data +for the controller specified by \fIcntid\fP + +Will return an error if the length of the response data (from the +controller) is not a full \fINVME_IDENTIFY_DATA_SIZE\fP, so \fIcap\fP will be +be fully populated on success. + +See: \fIstruct nvme_primary_ctrl_cap\fP +.SH "RETURN" +0 on success, non-zero on failure -- cgit v1.2.3