Skip to content

Commit aedf4e0

Browse files
ikegami-tigaw
ikegami-t
authored and
igaw
committed
doc: add get and set feature commands symbolic names
The feature-id parameter can be set the symbolic names also. Signed-off-by: Tokunori Ikegami <[email protected]>
1 parent 00a36e0 commit aedf4e0

File tree

2 files changed

+98
-0
lines changed

2 files changed

+98
-0
lines changed

‎Documentation/nvme-get-feature.txt‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,55 @@ OPTIONS
4444
--feature-id=<fid>::
4545
The feature id to send with the command. Value provided should
4646
be in hex.
47+
+
48+
[]
49+
|=================
50+
|Value|Definition
51+
|0x01 \| 'arbitration'| Arbitration
52+
|0x02 \| 'power-mgmt'| Power Management
53+
|0x03 \| 'lba-range'| LBA Range Type
54+
|0x04 \| 'temp-thresh'| Temperature Threshold
55+
|0x05 \| 'err-recovery'| Error Recovery
56+
|0x06 \| 'volatile-wc'| Volatile Write Cache
57+
|0x07 \| 'num-queues'| Number of Queues
58+
|0x08 \| 'irq-coalesce'| Interrupt Coalescing
59+
|0x09 \| 'irq-config'| Interrupt Vector Configuration
60+
|0x0a \| 'write-atomic'| Write Atomicity Normal
61+
|0x0b \| 'async-event'| Asynchronous Event Configuration
62+
|0x0c \| 'auto-pst'| Autonomous Power State Transition
63+
|0x0d \| 'host-mem-buf'| Host Memory Buffer
64+
|0x0e \| 'timestamp'| Timestamp
65+
|0x0f \| 'kato'| Keep Alive Timer
66+
|0x10 \| 'hctm'| Host Controlled Thermal Management
67+
|0x11 \| 'nopsc'| Non-Operational Power State Config
68+
|0x12 \| 'rrl'| Read Recovery Level Config
69+
|0x13 \| 'plm-config'| Predictable Latency Mode Config
70+
|0x14 \| 'plm-window'| Predictable Latency Mode Window
71+
|0x15 \| 'lba-sts-interval'| LBA Status Information Report Interval
72+
|0x16 \| 'host-behavior'| Host Behavior Support
73+
|0x17 \| 'sanitize'| Sanitize Config
74+
|0x18 \| 'endurance-evt-cfg'| Endurance Group Event Configuration
75+
|0x19 \| 'iocs-profile'| I/O Command Set Profile
76+
|0x1a \| 'spinup-control'| Spinup Control
77+
|0x1b \| 'power-loss-signal'| Power Loss Signaling Config
78+
|0x1c \| 'perf-characteristics'|Performance Characteristics
79+
|0x1d \| 'fdp'| Flexible Data Placement
80+
|0x1e \| 'fdp-events'| FDP Events
81+
|0x1f \| 'ns-admin-label'| Namespace Admin Label
82+
|0x20 \| 'key-value'| Key Value Configuration
83+
|0x21 \| 'ctrl-data-queue'| Controller Data Queue
84+
|0x78 \| 'emb-mgmt-ctrl-addr'| Embedded Management Controller Address
85+
|0x79 \| 'host-mgmt-agent-addr'|Host Management Agent Address
86+
|0x7d \| 'enh-ctrl-metadata'| Enhanced Controller Metadata
87+
|0x7e \| 'ctrl-metadata'| Controller Metadata
88+
|0x7f \| 'ns-metadata'| Namespace Metadata
89+
|0x80 \| 'sw-progress'| Software Progress Marker
90+
|0x81 \| 'host-id'| Host Identifier
91+
|0x82 \| 'resv-mask'| Reservation Notification Mask
92+
|0x83 \| 'resv-persist'| Reservation Persistence
93+
|0x84 \| 'write-protect'| Namespace Write Protection Config
94+
|0x85 \| 'bp-write-protect'| Boot Partition Write Protection Config
95+
|=================
4796

4897
-s <select>::
4998
--sel=<select>::

‎Documentation/nvme-set-feature.txt‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,55 @@ OPTIONS
3939
--feature-id=<fid>::
4040
The feature id to send with the command. Value provided should
4141
be in hex.
42+
+
43+
[]
44+
|=================
45+
|Value|Definition
46+
|0x01 \| 'arbitration'| Arbitration
47+
|0x02 \| 'power-mgmt'| Power Management
48+
|0x03 \| 'lba-range'| LBA Range Type
49+
|0x04 \| 'temp-thresh'| Temperature Threshold
50+
|0x05 \| 'err-recovery'| Error Recovery
51+
|0x06 \| 'volatile-wc'| Volatile Write Cache
52+
|0x07 \| 'num-queues'| Number of Queues
53+
|0x08 \| 'irq-coalesce'| Interrupt Coalescing
54+
|0x09 \| 'irq-config'| Interrupt Vector Configuration
55+
|0x0a \| 'write-atomic'| Write Atomicity Normal
56+
|0x0b \| 'async-event'| Asynchronous Event Configuration
57+
|0x0c \| 'auto-pst'| Autonomous Power State Transition
58+
|0x0d \| 'host-mem-buf'| Host Memory Buffer
59+
|0x0e \| 'timestamp'| Timestamp
60+
|0x0f \| 'kato'| Keep Alive Timer
61+
|0x10 \| 'hctm'| Host Controlled Thermal Management
62+
|0x11 \| 'nopsc'| Non-Operational Power State Config
63+
|0x12 \| 'rrl'| Read Recovery Level Config
64+
|0x13 \| 'plm-config'| Predictable Latency Mode Config
65+
|0x14 \| 'plm-window'| Predictable Latency Mode Window
66+
|0x15 \| 'lba-sts-interval'| LBA Status Information Report Interval
67+
|0x16 \| 'host-behavior'| Host Behavior Support
68+
|0x17 \| 'sanitize'| Sanitize Config
69+
|0x18 \| 'endurance-evt-cfg'| Endurance Group Event Configuration
70+
|0x19 \| 'iocs-profile'| I/O Command Set Profile
71+
|0x1a \| 'spinup-control'| Spinup Control
72+
|0x1b \| 'power-loss-signal'| Power Loss Signaling Config
73+
|0x1c \| 'perf-characteristics'|Performance Characteristics
74+
|0x1d \| 'fdp'| Flexible Data Placement
75+
|0x1e \| 'fdp-events'| FDP Events
76+
|0x1f \| 'ns-admin-label'| Namespace Admin Label
77+
|0x20 \| 'key-value'| Key Value Configuration
78+
|0x21 \| 'ctrl-data-queue'| Controller Data Queue
79+
|0x78 \| 'emb-mgmt-ctrl-addr'| Embedded Management Controller Address
80+
|0x79 \| 'host-mgmt-agent-addr'|Host Management Agent Address
81+
|0x7d \| 'enh-ctrl-metadata'| Enhanced Controller Metadata
82+
|0x7e \| 'ctrl-metadata'| Controller Metadata
83+
|0x7f \| 'ns-metadata'| Namespace Metadata
84+
|0x80 \| 'sw-progress'| Software Progress Marker
85+
|0x81 \| 'host-id'| Host Identifier
86+
|0x82 \| 'resv-mask'| Reservation Notification Mask
87+
|0x83 \| 'resv-persist'| Reservation Persistence
88+
|0x84 \| 'write-protect'| Namespace Write Protection Config
89+
|0x85 \| 'bp-write-protect'| Boot Partition Write Protection Config
90+
|=================
4291

4392
-l <data-len>::
4493
--data-len=<data-len>::

0 commit comments

Comments
 (0)