d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nvmecontrol: document power command

Browse Source 
The description of the power command is missing. While the synopsis is
present, there's no explanation. Add one.

Reviewed by:		mav, chuck
PR:			237866
Sponsored by:		Netflix
Differential Revision:	https://reviews.freebsd.org/D31122
This commit is contained in:
Warner Losh 2021-07-10 10:51:15 -06:00
parent 3a522ba1bc
commit 445b5554bf
1 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
sbin/nvmecontrol/nvmecontrol.8
View File

@ -470,6 +470,37 @@ Run in
mode.
This will report status on a sanitize that is already running on the drive.
.El
.Ss power
Manage the power modes of the NVMe controller.
.Bl -tag -width 6n
.It Fl l
List all supported power modes.
.It Fl p Ar mode
Set the power mode to
.Ar mode .
This must be a mode listed with the
.Dl nvmecontrol power -l
command.
.It Fl w Ar hint
Set the workload hint for automatic power mode control.
.Bl -tag -compact -width 6n
.It 0
No workload hint is provided.
.It 1
Extended idle period workload.
The device is often idle for minutes at a time.
A burst of write commands comes in over a period of seconds.
Then the device returns to being idle.
.It 2
Heavy sequential writes.
A huge number of sequential writes will be submitted, filling the submission queues.
.It Other
All other values are reserved and have no standard meaning.
.El
Please see the
.Dq NVM Subsystem Workloads
section of the relevant NVM Express Base Standard for details.
.El
.Ss selftest
Start the specified device self-test:
.Bl -tag -width 6n
@ -505,7 +536,7 @@ and
commands send NVMe commands to
either the administrative or the data part of the device.
These commands are expected to be compatible with nvme-cli.
Please see the NVMe Standard for details.
Please see the NVM Express Base Standard for details.
.Bl -tag -width 16n
.It Fl o -opcode Ar opcode
Opcode to send.