Skip to content

Commit 0cfa413

Browse files
ikegami-tigaw
authored andcommitted
nvme, doc: update fw-commit action help message and documentation
Add the ca definition names description for the values. Signed-off-by: Tokunori Ikegami <[email protected]>
1 parent 63e7fcf commit 0cfa413

2 files changed

Lines changed: 18 additions & 12 deletions

File tree

Documentation/nvme-fw-commit.txt

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,20 @@ OPTIONS
5151
[]
5252
|=================
5353
|Value|Definition
54-
|0|Downloaded image replaces the image indicated by the Firmware Slot
55-
field. This image is not activated.
56-
|1|Downloaded image replaces the image indicated by the Firmware Slot
57-
field. This image is activated at the next reset.
58-
|2|The image indicated by the Firmware Slot field is activated at the
54+
|0 \| 'replace'| Downloaded image replaces the image indicated by the
55+
Firmware Slot field. This image is not activated.
56+
|1 \| 'replace-and-activate'| Downloaded image replaces the image
57+
indicated by the Firmware Slot field. This image is activated at the
5958
next reset.
60-
|3|The image specified by the Firmware Slot field is requested to be
61-
activated immediately without reset.
62-
|6|Downloaded image replaces the Boot Partition specified by the Boot Partition
63-
ID field.
64-
|7|Mark the Boot Partition specified in the BPID field as active and update
65-
BPINFO.ABPID.
59+
|2 \| 'set-active'| The image indicated by the Firmware Slot field is
60+
activated at the next reset.
61+
|3 \| 'replace-and-activate-immediate'| The image specified by the
62+
Firmware Slot field is requested to be activated immediately without
63+
reset.
64+
|6 \| 'replace-boot-partition'| Downloaded image replaces the Boot
65+
Partition specified by the Boot Partition ID field.
66+
|7 \| 'activate-boot-partition'| Mark the Boot Partition specified in
67+
the BPID field as active and update BPINFO.ABPID.
6668
|=================
6769

6870
-s <slot>::

nvme.c

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5272,7 +5272,11 @@ static int fw_commit(int argc, char **argv, struct command *acmd, struct plugin
52725272
"with an 'echo 1 > /sys/class/nvme/nvmeX/reset_controller'. "
52735273
"Ensure nvmeX is the device you just activated before reset.";
52745274
const char *slot = "[0-7]: firmware slot for commit action";
5275-
const char *action = "[0-7]: commit action";
5275+
const char *action = "[0-7]: commit action: 0 = replace, "
5276+
"1 = replace and activate, 2 = set active, "
5277+
"3 = replace and activate immediate, "
5278+
"6 = replace boot partition, "
5279+
"7 = activate boot partition";
52765280
const char *bpid = "[0,1]: boot partition identifier, if applicable (default: 0)";
52775281

52785282
_cleanup_nvme_global_ctx_ struct nvme_global_ctx *ctx = NULL;

0 commit comments

Comments
 (0)