Skip to content

Commit 0ef21f4

Browse files
lgdacunhigaw
authored andcommitted
doc: Add nvme-fdp-feature command
Adds helper command to enable FDP configuration. Signed-off-by: Leonardo da Cunha <[email protected]>
1 parent 9d28dcc commit 0ef21f4

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

Documentation/meson.build

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ adoc_sources = [
3232
'nvme-error-log',
3333
'nvme-fdp-configs',
3434
'nvme-fdp-events',
35+
'nvme-fdp-feature',
3536
'nvme-fdp-set-events',
3637
'nvme-fdp-stats',
3738
'nvme-fdp-status',

Documentation/nvme-fdp-feature.txt

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
nvme-fdp-feature(1)
2+
===================
3+
4+
NAME
5+
----
6+
nvme-fdp-feature - Show or change Flexible Data Placement (FDP) Feature
7+
8+
SYNOPSIS
9+
--------
10+
[verse]
11+
'nvme fdp' <device> [--endgrp-id=<NUM> | -e <NUM>]
12+
[--enable-conf-idx=<NUM> | -c <NUM>]
13+
[--disable | -d]
14+
[--verbose | -v]
15+
16+
DESCRIPTION
17+
-----------
18+
For the NVMe device given, configure and manage the Flexible Data Placement (FDP) feature.
19+
20+
This command can be used to either show the current FDP feature configuration or change it.
21+
22+
If no `--enable-conf-idx` or `--disable` options are provided, the current configuration is
23+
displayed.
24+
25+
If the `--enable-conf-idx` or `--disable` options are provided, configuration is changed
26+
accordingly. Device may refuse the change if there is a namespace.
27+
28+
The <device> parameter is mandatory and must be a NVMe character device (ex: /dev/nvme0)
29+
30+
OPTIONS
31+
-------
32+
-e <NUM>::
33+
--endgrp-id=<NUM>::
34+
Specify the endurance group ID. This option is mandatory if device supports endurance groups.
35+
36+
-c <NUM>::
37+
--enable-conf-idx=<NUM>::
38+
Enable FDP feature with the specified configuration. The configuration index matches position
39+
listed by nvme-fdp-config(1).
40+
41+
-d::
42+
--disable::
43+
Disable the current FDP feature configuration.
44+
45+
-v::
46+
--verbose::
47+
Increase verbosity of the output.
48+
49+
SEE ALSO
50+
--------
51+
nvme-list-endgrp(1)
52+
nvme-fdp-config(1)
53+
54+
NVME
55+
----
56+
Part of nvme-cli

0 commit comments

Comments
 (0)