From f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Wed, 10 Apr 2024 21:41:32 +0200
Subject: Adding upstream version 2.8.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 Documentation/nvme-zns-zone-mgmt-recv.txt | 76 +++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 Documentation/nvme-zns-zone-mgmt-recv.txt

(limited to 'Documentation/nvme-zns-zone-mgmt-recv.txt')

diff --git a/Documentation/nvme-zns-zone-mgmt-recv.txt b/Documentation/nvme-zns-zone-mgmt-recv.txt
new file mode 100644
index 0000000..5a3e2a3
--- /dev/null
+++ b/Documentation/nvme-zns-zone-mgmt-recv.txt
@@ -0,0 +1,76 @@
+nvme-zns-zone-mgmt-recv(1)
+==========================
+
+NAME
+----
+nvme-zns-zone-mgmt-recv - Zone Management Receive command
+
+SYNOPSIS
+--------
+[verse]
+'nvme zns zone-mgmt-recv' <device> [--namespace-id=<NUM> | -n <NUM>]
+			[--start-lba=<LBA> | -s <LBA>]
+			[--data-len=<IONUM>, -l <IONUM>]
+			[--zra=<NUM>, -z <NUM>] [--zrasf=<NUM>, -a <NUM>]
+			[--zra-spec-feat, -f] [--output-format=<fmt>, -o <fmt>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, issues the Zone Management Receive command with the
+requested receive action and additional action specific parameters. This is the
+generic interface provided for forward compatibility as new actions are created
+that this program isn't aware of at the time of its development. As such, this
+is a generic command that does not do any additional decoding for specific
+types of data received. This will only report the data as a hex dump, or
+binary. 
+
+OPTIONS
+-------
+-n <NUM>::
+--namespace-id=<NUM>::
+	Use the provided namespace id for the command. If not provided, the
+	namespace id of the block device will be used. If the command is issued
+	to a non-block device, the parameter is required.
+
+-s <lba>::
+--start-lba=<lba>::
+	The starting LBA of the zone to manage receive.
+
+-l <NUM>
+--data-len=<NUM>
+	Received data buffer length
+
+-z <NUM>::
+--zra=<NUM>::
+	Zone Receive Action
+
+-a <NUM>
+--zrasf=<NUM>
+	Zone Receive Action Specific field
+
+-f::
+--zra-spec-feat::
+	Enable Zone Receive Action Specific features
+
+-o <fmt>::
+--output-format=<fmt>::
+	Output format: normal|json|binary
+
+EXAMPLES
+--------
+* Hex dump of a report all zones
++
+------------
+# nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -l 4k
+------------
++
+
+* Binary dump of a report all zones
++
+------------
+# nvme zns zone-mgmt-recv /dev/nvme0 -n 1 -s 0 -z 0 -a 0 -o -l 4k binary > report.out
+------------
+
+NVME
+----
+Part of nvme-cli
-- 
cgit v1.2.3