From owner-dev-commits-src-all@freebsd.org Mon Jul 12 19:43:45 2021
Return-Path: <owner-dev-commits-src-all@freebsd.org>
Delivered-To: dev-commits-src-all@mailman.nyi.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1])
by mailman.nyi.freebsd.org (Postfix) with ESMTP id 1C62E665B3F;
Mon, 12 Jul 2021 19:43:45 +0000 (UTC) (envelope-from git@FreeBSD.org)
Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org
[IPv6:2610:1c1:1:606c::19:3])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256
client-signature RSA-PSS (4096 bits) client-digest SHA256)
(Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK))
by mx1.freebsd.org (Postfix) with ESMTPS id 4GNvMh5kT5z3hQB;
Mon, 12 Jul 2021 19:43:44 +0000 (UTC) (envelope-from git@FreeBSD.org)
Received: from gitrepo.freebsd.org (gitrepo.freebsd.org
[IPv6:2610:1c1:1:6068::e6a:5])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256)
(Client did not present a certificate)
by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 9C4FF14D43;
Mon, 12 Jul 2021 19:43:44 +0000 (UTC) (envelope-from git@FreeBSD.org)
Received: from gitrepo.freebsd.org ([127.0.1.44])
by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 16CJhikF030284;
Mon, 12 Jul 2021 19:43:44 GMT (envelope-from git@gitrepo.freebsd.org)
Received: (from git@localhost)
by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 16CJhiKe030283;
Mon, 12 Jul 2021 19:43:44 GMT (envelope-from git)
Date: Mon, 12 Jul 2021 19:43:44 GMT
Message-Id: <202107121943.16CJhiKe030283@gitrepo.freebsd.org>
To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org,
dev-commits-src-branches@FreeBSD.org
From: Warner Losh <imp@FreeBSD.org>
Subject: git: 39d7a1f47909 - stable/13 - nvmecontrol: document power command
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
X-Git-Committer: imp
X-Git-Repository: src
X-Git-Refname: refs/heads/stable/13
X-Git-Reftype: branch
X-Git-Commit: 39d7a1f4790910c990db53a2eb75cba34ab734bf
Auto-Submitted: auto-generated
X-BeenThere: dev-commits-src-all@freebsd.org
X-Mailman-Version: 2.1.34
Precedence: list
List-Id: Commit messages for all branches of the src repository
<dev-commits-src-all.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/dev-commits-src-all>,
<mailto:dev-commits-src-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/dev-commits-src-all/>
List-Post: <mailto:dev-commits-src-all@freebsd.org>
List-Help: <mailto:dev-commits-src-all-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/dev-commits-src-all>,
<mailto:dev-commits-src-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 12 Jul 2021 19:43:45 -0000
The branch stable/13 has been updated by imp:
URL: https://cgit.FreeBSD.org/src/commit/?id=39d7a1f4790910c990db53a2eb75cba34ab734bf
commit 39d7a1f4790910c990db53a2eb75cba34ab734bf
Author: Warner Losh <imp@FreeBSD.org>
AuthorDate: 2021-07-10 16:51:15 +0000
Commit: Warner Losh <imp@FreeBSD.org>
CommitDate: 2021-07-12 19:42:59 +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.