Skip to content

Commit

Permalink
doc: Add nvme-fdp-feature command
Browse files Browse the repository at this point in the history
Adds helper command to enable FDP configuration.

Signed-off-by: Leonardo da Cunha <leonardo.da.cunha@solidigm.com>
  • Loading branch information
lgdacunh authored and igaw committed Feb 17, 2025
1 parent 9d28dcc commit 0ef21f4
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
1 change: 1 addition & 0 deletions Documentation/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
56 changes: 56 additions & 0 deletions Documentation/nvme-fdp-feature.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 0ef21f4

Please sign in to comment.