'\" t
-.\" Title: nvme-fw-activate
-.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\" Date: 12/10/2017
+.\" Title: nvme-fw-commit
+.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 12/19/2017
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FW\-ACTIVATE" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-FW\-COMMIT" "1" "12/19/2017" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-nvme-fw-activate \- Used to verify and commit a firmware image\&.
+nvme-fw-commit \- Used to verify and commit a firmware image\&.
.SH "SYNOPSIS"
.sp
.nf
-\fInvme fw\-activate\fR <device> [\-\-slot=<slot> | \-s <slot>]
+\fInvme fw\-commit\fR <device> [\-\-slot=<slot> | \-s <slot>]
[\-\-action=<action> | \-a <action>]
+ [\-\-bpid=<boot\-partid> | \-b <boot\-partid> ]
.fi
.SH "DESCRIPTION"
.sp
-For the NVMe device given, send an nvme Firmware Activate admin command and provides the results\&.
+For the NVMe device given, send an nvme Firmware Commit admin command and provides the results\&.
.sp
-The Firmware Activate command is used to verify that a valid firmware image has been downloaded and to commit that revision to a specific firmware slot\&. The host may select the firmware image to activate on the next controller reset (CC\&.EN transitions from \(oq1\(cq to \(oq0\(cq, a PCI function level reset, and/or other Controller or NVM Subsystem Reset) as part of this command\&. The currently executing firmware revision may be determined from the Firmware Revision field of the Identify Controller data structure as indicated in the Firmware Slot Information log page\&.
+The Firmware Commit command is used to verify that a valid firmware image has been downloaded and to commit that revision to a specific firmware slot\&. The host may select the firmware image to commit on the next controller reset (CC\&.EN transitions from \(oq1\(cq to \(oq0\(cq, a PCI function level reset, and/or other Controller or NVM Subsystem Reset) as part of this command\&. The currently executing firmware revision may be determined from the Firmware Revision field of the Identify Controller data structure as indicated in the Firmware Slot Information log page\&.
.sp
-No further action is automatically taken to reset the device, which is usually required to complete the activation process\&. If your kernel and driver are recent enough, you can activate the firmware by issuing a reset through Linux sysfs, for example:
+No further action is automatically taken to reset the device, which is usually required to complete the activation process\&. If your kernel and driver are recent enough, you can commit the firmware by issuing a reset through Linux sysfs, for example:
.sp
.if n \{\
.RS 4
.PP
\-a <action>, \-\-action=<action>
.RS 4
-Activate Action: This field specifies the action that is taken on the image downloaded with the Firmware Image Download command or on a previously downloaded and placed image\&.
+Commit Action: This field specifies the action that is taken on the image downloaded with the Firmware Image Download command or on a previously downloaded and placed image\&.
.TS
allbox tab(:);
lt lt
lt lt
lt lt
lt lt
+lt lt
+lt lt
lt lt.
T{
Value
T}:T{
The image specified by the Firmware Slot field is requested to be activated immediately without reset\&.
T}
+T{
+6
+T}:T{
+Downloaded image replaces the Boot Partition specified by the Boot Partition ID field\&.
+T}
+T{
+7
+T}:T{
+Mark the Boot Partition specified in the BPID field as active and update BPINFO\&.ABPID\&.
+T}
.TE
.sp 1
.RE
.PP
\-s <slot>, \-\-slot=<slot>
.RS 4
-Firmware Slot: Specifies the firmware slot that shall be used for the Activate Action, if applicable\&. If the value specified is 0h, then the controller shall choose the firmware slot (slot 1 \(en 7) to use for the operation\&.
+Firmware Slot: Specifies the firmware slot that shall be used for the Commit Action, if applicable\&. If the value specified is 0h, then the controller shall choose the firmware slot (slot 1 \(en 7) to use for the operation\&.
+.RE
+.PP
+\-\-bpid=<boot\-partid>, \-b <boot\-partid>
+.RS 4
+Specifiies the Boot partition that shall be used for the Commit Action, if applicable (default: 0)
.RE
.SH "EXAMPLES"
.sp
.sp -1
.IP \(bu 2.3
.\}
-Activate the last downloaded fw to slot 1\&.
+commit the last downloaded fw to slot 1\&.
.sp
.if n \{\
.RS 4
.\}
.nf
-# nvme fw\-activate /dev/nvme0 \-\-slot=1 \-\-action=2
+# nvme fw\-commit /dev/nvme0 \-\-slot=1 \-\-action=2
.fi
.if n \{\
.RE
.\}
.RE
+.SH "ALIAS"
+.sp
+fw\-activate
.SH "NVME"
.sp
Part of the nvme\-user suite
<head>\r
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
<meta name="generator" content="AsciiDoc 8.6.8" />\r
-<title>nvme-fw-activate(1)</title>\r
+<title>nvme-fw-commit(1)</title>\r
<style type="text/css">\r
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
\r
<body class="manpage">\r
<div id="header">\r
<h1>\r
-nvme-fw-activate(1) Manual Page\r
+nvme-fw-commit(1) Manual Page\r
</h1>\r
<h2>NAME</h2>\r
<div class="sectionbody">\r
-<p>nvme-fw-activate -\r
+<p>nvme-fw-commit -\r
Used to verify and commit a firmware image.\r
</p>\r
</div>\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme fw-activate</em> <device> [--slot=<slot> | -s <slot>]\r
- [--action=<action> | -a <action>]</pre>\r
+<pre class="content"><em>nvme fw-commit</em> <device> [--slot=<slot> | -s <slot>]\r
+ [--action=<action> | -a <action>]\r
+ [--bpid=<boot-partid> | -b <boot-partid> ]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>For the NVMe device given, send an nvme Firmware Activate admin command\r
+<div class="paragraph"><p>For the NVMe device given, send an nvme Firmware Commit admin command\r
and provides the results.</p></div>\r
-<div class="paragraph"><p>The Firmware Activate command is used to verify that a valid firmware\r
+<div class="paragraph"><p>The Firmware Commit command is used to verify that a valid firmware\r
image has been downloaded and to commit that revision to a specific\r
-firmware slot. The host may select the firmware image to activate on the\r
+firmware slot. The host may select the firmware image to commit on the\r
next controller reset (CC.EN transitions from ‘1’ to ‘0’, a PCI\r
function level reset, and/or other Controller or NVM Subsystem Reset)\r
as part of this command. The currently executing firmware revision may\r
data structure as indicated in the Firmware Slot Information log page.</p></div>\r
<div class="paragraph"><p>No further action is automatically taken to reset the device, which is\r
usually required to complete the activation process. If your kernel and\r
-driver are recent enough, you can activate the firmware by issuing a\r
+driver are recent enough, you can commit the firmware by issuing a\r
reset through Linux sysfs, for example:</p></div>\r
<div class="listingblock">\r
<div class="content">\r
</dt>\r
<dd>\r
<p>\r
- Activate Action: This field specifies the action that is taken\r
+ Commit Action: This field specifies the action that is taken\r
on the image downloaded with the Firmware Image Download command\r
or on a previously downloaded and placed image.\r
</p>\r
<td align="left" valign="top"><p class="table">The image specified by the Firmware Slot field is requested to be\r
activated immediately without reset.</p></td>\r
</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">6</p></td>\r
+<td align="left" valign="top"><p class="table">Downloaded image replaces the Boot Partition specified by the Boot Partition\r
+ID field.</p></td>\r
+</tr>\r
+<tr>\r
+<td align="left" valign="top"><p class="table">7</p></td>\r
+<td align="left" valign="top"><p class="table">Mark the Boot Partition specified in the BPID field as active and update\r
+BPINFO.ABPID.</p></td>\r
+</tr>\r
</tbody>\r
</table>\r
</div>\r
<dd>\r
<p>\r
Firmware Slot: Specifies the firmware slot that shall be used for\r
- the Activate Action, if applicable. If the value specified is 0h,\r
+ the Commit Action, if applicable. If the value specified is 0h,\r
then the controller shall choose the firmware slot (slot 1 – 7)\r
to use for the operation.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+--bpid=<boot-partid>\r
+</dt>\r
+<dt class="hdlist1">\r
+-b <boot-partid>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Specifiies the Boot partition that shall be used for the Commit Action,\r
+ if applicable (default: 0)\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
-Activate the last downloaded fw to slot 1.\r
+commit the last downloaded fw to slot 1.\r
</p>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><code># nvme fw-activate /dev/nvme0 --slot=1 --action=2</code></pre>\r
+<pre><code># nvme fw-commit /dev/nvme0 --slot=1 --action=2</code></pre>\r
</div></div>\r
</li>\r
</ul></div>\r
</div>\r
</div>\r
<div class="sect1">\r
+<h2 id="_alias">ALIAS</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>fw-activate</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
<h2 id="_nvme">NVME</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>Part of the nvme-user suite</p></div>\r
<div id="footnotes"><hr /></div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 2017-08-28 10:19:30 EDT\r
+Last updated 2017-12-19 13:33:25 MST\r
</div>\r
</div>\r
</body>\r
-nvme-fw-activate(1)
-===================
+nvme-fw-commit(1)
+=================
NAME
----
-nvme-fw-activate - Used to verify and commit a firmware image.
+nvme-fw-commit - Used to verify and commit a firmware image.
SYNOPSIS
--------
[verse]
-'nvme fw-activate' <device> [--slot=<slot> | -s <slot>]
+'nvme fw-commit' <device> [--slot=<slot> | -s <slot>]
[--action=<action> | -a <action>]
+ [--bpid=<boot-partid> | -b <boot-partid> ]
DESCRIPTION
-----------
-For the NVMe device given, send an nvme Firmware Activate admin command
+For the NVMe device given, send an nvme Firmware Commit admin command
and provides the results.
-The Firmware Activate command is used to verify that a valid firmware
+The Firmware Commit command is used to verify that a valid firmware
image has been downloaded and to commit that revision to a specific
-firmware slot. The host may select the firmware image to activate on the
+firmware slot. The host may select the firmware image to commit on the
next controller reset (CC.EN transitions from ‘1’ to ‘0’, a PCI
function level reset, and/or other Controller or NVM Subsystem Reset)
as part of this command. The currently executing firmware revision may
No further action is automatically taken to reset the device, which is
usually required to complete the activation process. If your kernel and
-driver are recent enough, you can activate the firmware by issuing a
+driver are recent enough, you can commit the firmware by issuing a
reset through Linux sysfs, for example:
------------
-------
-a <action>::
--action=<action>::
- Activate Action: This field specifies the action that is taken
+ Commit Action: This field specifies the action that is taken
on the image downloaded with the Firmware Image Download command
or on a previously downloaded and placed image.
+
next reset.
|3|The image specified by the Firmware Slot field is requested to be
activated immediately without reset.
+|6|Downloaded image replaces the Boot Partition specified by the Boot Partition
+ID field.
+|7|Mark the Boot Partition specified in the BPID field as active and update
+BPINFO.ABPID.
|=================
-s <slot>::
--slot=<slot>::
Firmware Slot: Specifies the firmware slot that shall be used for
- the Activate Action, if applicable. If the value specified is 0h,
+ the Commit Action, if applicable. If the value specified is 0h,
then the controller shall choose the firmware slot (slot 1 – 7)
to use for the operation.
+--bpid=<boot-partid>::
+-b <boot-partid>::
+ Specifiies the Boot partition that shall be used for the Commit Action,
+ if applicable (default: 0)
+
EXAMPLES
--------
-* Activate the last downloaded fw to slot 1.
+* commit the last downloaded fw to slot 1.
+
------------
-# nvme fw-activate /dev/nvme0 --slot=1 --action=2
+# nvme fw-commit /dev/nvme0 --slot=1 --action=2
------------
+ALIAS
+-----
+
+fw-activate
NVME
----
{
char man[0x100];
struct program *prog = plugin->parent;
+ char *str = argv[1];
+ int i;
if (argc == 1) {
general_help(plugin);
return 0;
}
- if (plugin->name)
- sprintf(man, "%s-%s-%s", prog->name, plugin->name, argv[1]);
- else
- sprintf(man, "%s-%s", prog->name, argv[1]);
- if (execlp("man", "man", man, (char *)NULL))
- perror(argv[1]);
+ for (i = 0; plugin->commands[i]; i++) {
+ struct command *cmd = plugin->commands[i];
+
+ if (strcmp(str, cmd->name))
+ if (!cmd->alias || (cmd->alias && strcmp(str, cmd->alias)))
+ continue;
+
+ if (plugin->name)
+ sprintf(man, "%s-%s-%s", prog->name, plugin->name, cmd->name);
+ else
+ sprintf(man, "%s-%s", prog->name, cmd->name);
+ if (execlp("man", "man", man, (char *)NULL))
+ perror(argv[1]);
+ }
return 0;
}
while (*str == '-')
str++;
+ if (!strcmp(str, "help"))
+ return help(argc, argv, plugin);
+ if (!strcmp(str, "version"))
+ return version(plugin);
+
for (; plugin->commands[i]; i++) {
struct command *cmd = plugin->commands[i];
- if (!strcmp(str, "help"))
- return help(argc, argv, plugin);
- if (!strcmp(str, "version"))
- return version(plugin);
if (strcmp(str, cmd->name))
if (!cmd->alias || (cmd->alias && strcmp(str, cmd->alias)))
continue;
projects / users / hch / nvme-cli.git / commitdiff