doc: Add nvme-fdp-feature command

Adds helper command to enable FDP configuration.

Signed-off-by: Leonardo da Cunha <leonardo.da.cunha@solidigm.com>

diff --git a/Documentation/meson.build b/Documentation/meson.build
index 65495e3cceee6a4b83b9f5c02dbf7b3cdf7a8195..e81db8c902710030950d17beebdf5ac6375dacde 100644 (file)
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -32,6 +32,7 @@ adoc_sources = [
   'nvme-error-log',
   'nvme-fdp-configs',
   'nvme-fdp-events',
+  'nvme-fdp-feature',
   'nvme-fdp-set-events',
   'nvme-fdp-stats',
   'nvme-fdp-status',

diff --git a/Documentation/nvme-fdp-feature.txt b/Documentation/nvme-fdp-feature.txt
new file mode 100644 (file)
index 0000000..543c788
--- /dev/null
+++ b/Documentation/nvme-fdp-feature.txt
@@ -0,0 +1,56 @@
+nvme-fdp-feature(1)
+===================
+
+NAME
+----
+nvme-fdp-feature - Show or change Flexible Data Placement (FDP) Feature
+
+SYNOPSIS
+--------
+[verse]
+'nvme fdp' <device> [--endgrp-id=<NUM> | -e <NUM>]
+                [--enable-conf-idx=<NUM> | -c <NUM>]
+                [--disable | -d]
+                [--verbose | -v]
+
+DESCRIPTION
+-----------
+For the NVMe device given, configure and manage the Flexible Data Placement (FDP) feature.
+
+This command can be used to either show the current FDP feature configuration or change it.
+
+ If no `--enable-conf-idx` or `--disable` options are provided, the current configuration is
+displayed.
+
+If the `--enable-conf-idx` or `--disable` options are provided, configuration is changed
+accordingly. Device may refuse the change if there is a namespace.
+
+The <device> parameter is mandatory and must be a NVMe character device (ex: /dev/nvme0)
+
+OPTIONS
+-------
+-e <NUM>::
+--endgrp-id=<NUM>::
+    Specify the endurance group ID. This option is mandatory if device supports endurance groups.
+
+-c <NUM>::
+--enable-conf-idx=<NUM>::
+    Enable FDP feature with the specified configuration. The configuration index matches position
+    listed by nvme-fdp-config(1).
+
+-d::
+--disable::
+    Disable the current FDP feature configuration.
+
+-v::
+--verbose::
+    Increase verbosity of the output.
+
+SEE ALSO
+--------
+nvme-list-endgrp(1)
+nvme-fdp-config(1)
+
+NVME
+----
+Part of nvme-cli
\ No newline at end of file