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-wdc-drive-essentials.txt | 50 +++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 Documentation/nvme-wdc-drive-essentials.txt

(limited to 'Documentation/nvme-wdc-drive-essentials.txt')

diff --git a/Documentation/nvme-wdc-drive-essentials.txt b/Documentation/nvme-wdc-drive-essentials.txt
new file mode 100644
index 0000000..7f06040
--- /dev/null
+++ b/Documentation/nvme-wdc-drive-essentials.txt
@@ -0,0 +1,50 @@
+nvme-wdc-drive-essentials(1)
+============================
+
+NAME
+----
+nvme-wdc-drive-essentials - Retrieve WDC device's drive essentials bin files and
+save to a tar file.
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc drive-essentials' <device> [--dir-name=<DIRECTORY>, -d <DIRECTORY>] 
+
+DESCRIPTION
+-----------
+
+For the NVMe device given, captures the drive essential bin files and saves them
+into a tar file. The tar file will be in the following format:
+DRIVE_ESSENTIALS_<Serial Num>_<FW Revision>_<Date>_<Time>.tar.gz 
+ e.g. DRIVE_ESSENTIALS_A00FD8CA_1048_20170713_091731.tar.gz
+
+The <device> parameter is mandatory; NVMe character device (ex: /dev/nvme0).
+
+This will only work on WDC devices supporting this feature.
+Results for any other device are undefined.
+
+OPTIONS
+-------
+-d <DIRECTORY>::
+--dir-name=<DIRECTORY>::
+	Output directory; defaults to current working directory. 
+
+EXAMPLES
+--------
+* Gets the drive essentials data files from the device and saves the tar file in current directory
+  (e.g. DRIVE_ESSENTIALS_A00FD8CA_1048_20170713_091731.tar.gz):
++
+------------
+# nvme wdc drive-essentials /dev/nvme0 
+------------
+* Gets the drive essentials data files from the device and saves the tar file to specified directory 
+  (e.g. /tmp/DRIVE_ESSENTIALS_A00FD8CA_1048_20170713_091731):
++
+------------
+# nvme wdc drive-essentials /dev/nvme0 -d /tmp/ 
+------------
+
+NVME
+----
+Part of the nvme-user suite.
-- 
cgit v1.2.3