From: Tokunori Ikegami <ikegami.t@gmail.com>
Date: Tue, 11 Apr 2023 16:16:04 +0000 (+0900)
Subject: doc: Add nvme-mi-recv command documentation
X-Git-Tag: v2.5~181
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=99bcc9ead6227190fffacb908c1cb5886c4f2071;p=users%2Fsagi%2Fnvme-cli.git

doc: Add nvme-mi-recv command documentation

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
---

diff --git a/Documentation/meson.build b/Documentation/meson.build
index f555aea4..3a47937e 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -84,6 +84,7 @@ adoc_sources = [
   'nvme-netapp-smdevices',
   'nvme-ns-descs',
   'nvme-ns-rescan',
+  'nvme-nvme-mi-recv',
   'nvme-nvm-id-ctrl',
   'nvme-ocp-latency-monitor-log',
   'nvme-ocp-smart-add-log',
diff --git a/Documentation/nvme-nvme-mi-recv.txt b/Documentation/nvme-nvme-mi-recv.txt
new file mode 100644
index 00000000..e5130edc
--- /dev/null
+++ b/Documentation/nvme-nvme-mi-recv.txt
@@ -0,0 +1,70 @@
+nvme-nvme-mi-recv(1)
+====================
+
+NAME
+----
+nvme-nvme-mi-recv - Send a NVMe-MI Receive command to the specified device
+
+SYNOPSIS
+--------
+[verse]
+'nvme nvme-mi-recv' <device> [--opcode=<opcode> | -o <opcode>]
+			     [--namespace-id=<nsid>]
+			     [--data-len=<data-len> | -l <data-len>]
+			     [--nmimt=<nmimt> | -m <nmimt>]
+			     [--nmd0=<nmd0> | -0 <nmd0>]
+			     [--nmd1=<nmd1> | -1 <nmd1>]
+			     [--input-file=<file> | -i <file>]
+
+DESCRIPTION
+-----------
+Send a NVMe-MI Receive command to the specified device, return results.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).
+
+On success it returns 0, error code otherwise.
+
+OPTIONS
+-------
+-o <opcode>::
+--opcode=<opcode>::
+	The NVMe-MI opcode to send to the device in the command
+
+-n <nsid>::
+--namespace-id=<nsid>::
+	The value for the ns-id in the command.
+
+-l <data-len>::
+--data-len=<data-len>::
+	The data length for the buffer used for this command.
+
+-m <nmimt>::
+--nmimt=<nmimt>::
+	The value for the NVMe-MI message type in the command.
+
+-0 <nmd0>::
+--nmd0=<nmd0>::
+	The value for the NVMe management request dword 0 in the command.
+
+-1 <nmd1>::
+--nmd1=<nmd1>::
+	The value for the NVMe management request dword 1 in the command.
+
+-i <file>::
+--input-file=<file>::
+	If the command is a data-out (write) command, use this file
+	to fill the buffer sent to the device. If no file is given,
+	assumed to use STDIN.
+
+EXAMPLES
+--------
+* Has the program issue a nvme-mi-recv to execute the VPD read.
++
+------------
+# nvme nvme-mi-recv /dev/nvme0n1 -o 5 -m 1 -0 0 -1 0x100 -l 256
+------------
+
+NVME
+----
+Part of the nvme-user suite.