diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2023-06-30 22:38:48 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2023-06-30 22:38:48 +0000 |
commit | 01c4d3d32c5044d3d17055c2d94d40fee9d130e1 (patch) | |
tree | 2c213cd5436bff644fa7023b94674a9c12d2e1af /Documentation/nvme-ocp-eol-plp-failure-mode.txt | |
parent | Adding upstream version 2.4+really2.4. (diff) | |
download | nvme-cli-01c4d3d32c5044d3d17055c2d94d40fee9d130e1.tar.xz nvme-cli-01c4d3d32c5044d3d17055c2d94d40fee9d130e1.zip |
Adding upstream version 2.5.upstream/2.5
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | Documentation/nvme-ocp-eol-plp-failure-mode.txt | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/Documentation/nvme-ocp-eol-plp-failure-mode.txt b/Documentation/nvme-ocp-eol-plp-failure-mode.txt new file mode 100644 index 0000000..9a47375 --- /dev/null +++ b/Documentation/nvme-ocp-eol-plp-failure-mode.txt @@ -0,0 +1,69 @@ +nvme-ocp-eol-plp-failure-mode(1) +================================ + +NAME +---- +nvme-ocp-eol-plp-failure-mode - Define and print EOL or PLP circuitry failure mode + +SYNOPSIS +-------- +[verse] +'nvme ocp eol-plp-failure-mode' <device> [--mode=<mode> | -m <mode>] [--no-uuid | -n] [--save | -s] + [--sel=<select> | -s <select>] + +DESCRIPTION +----------- +Define EOL or PLP circuitry failure mode. +No argument prints current mode. + +The <device> parameter is mandatory and may be either the NVMe character +device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1). + +This will only work on OCP compliant devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-m <mode>:: +--mode=<mode>:: + Set the EOL or PLP circuitry failure mode to [0-3] ('0: default', + '1: rom', '2: wtm' or '3: normal'). Only one mode + can be used at a time. The default is rom. + +-n:: +--no-uuid:: + Do not try to automatically detect UUID index for this command (required + for old OCP 1.0 support) + +-s:: +--save:: + Save the attribute so that it persists through all power states and resets. + +-s <select>:: +--sel=<select>:: + Select (SEL): This field specifies which value of the attributes + to return in the provided data: ++ +[] +|================== +|Select|Description +|0|Current +|1|Default +|2|Saved +|3|Supported capabilities +|4-7|Reserved +|================== + +EXAMPLES +-------- +* Has the program issue a eol-plp-failure-mode to retrieve the 0xC2 get features. ++ +------------ +# nvme ocp eol-plp-failure-mode /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. |