git: 4905e7273229 - stable/12 - nvmecontrol: document power command

[Warner Losh]

The branch stable/12 has been updated by imp:

URL: https://cgit.FreeBSD.org/src/commit/?id=4905e7273229106f7fc62d2801f5295d50d718d0

commit 4905e7273229106f7fc62d2801f5295d50d718d0
Author:     Warner Losh <imp at FreeBSD.org>
AuthorDate: 2021-07-10 16:51:15 +0000
Commit:     Warner Losh <imp at FreeBSD.org>
CommitDate: 2021-07-31 05:02:56 +0000

    nvmecontrol: document power command
    
    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
    
    (cherry picked from commit 445b5554bf97254a0ead3d70f801871d62dcfb62)
---
 sbin/nvmecontrol/nvmecontrol.8 | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/sbin/nvmecontrol/nvmecontrol.8 b/sbin/nvmecontrol/nvmecontrol.8
index 2d634eb54216..7d70e1762f73 100644
--- a/sbin/nvmecontrol/nvmecontrol.8
+++ b/sbin/nvmecontrol/nvmecontrol.8
@@ -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.