blob: 823efce123f4805ded0d6f84c422f850338e4fd1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
'\" t
.\" Title: nvme-ocp-eol-plp-failure-mode
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 08/02/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-OCP\-EOL\-PLP\" "1" "08/02/2024" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-ocp-eol-plp-failure-mode \- Define and print EOL or PLP circuitry failure mode
.SH "SYNOPSIS"
.sp
.nf
\fInvme ocp eol\-plp\-failure\-mode\fR <device> [\-\-mode=<mode> | \-m <mode>]
[\-\-no\-uuid | \-n] [\-\-save | \-s]
[\-\-sel=<select> | \-S <select>]
.fi
.SH "DESCRIPTION"
.sp
Define EOL or PLP circuitry failure mode\&. No argument prints current mode\&.
.sp
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1)\&.
.sp
This will only work on OCP compliant devices supporting this feature\&. Results for any other device are undefined\&.
.sp
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
\-m <mode>, \-\-mode=<mode>
.RS 4
Set the EOL or PLP circuitry failure mode to [0\-3] (\fI0: default\fR,
\fI1: rom\fR,
\fI2: wtm\fR
or
\fI3: normal\fR)\&. Only one mode can be used at a time\&. The default is rom\&.
.RE
.PP
\-n, \-\-no\-uuid
.RS 4
Do not try to automatically detect UUID index for this command (required for old OCP 1\&.0 support)
.RE
.PP
\-s, \-\-save
.RS 4
Save the attribute so that it persists through all power states and resets\&.
.RE
.PP
\-s <select>, \-\-sel=<select>
.RS 4
Select (SEL): This field specifies which value of the attributes to return in the provided data:
.TS
allbox tab(:);
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt.
T{
Select
T}:T{
Description
T}
T{
0
T}:T{
Current
T}
T{
1
T}:T{
Default
T}
T{
2
T}:T{
Saved
T}
T{
3
T}:T{
Supported capabilities
T}
T{
4\-7
T}:T{
Reserved
T}
.TE
.sp 1
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Has the program issue a eol\-plp\-failure\-mode to retrieve the 0xC2 get features\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme ocp eol\-plp\-failure\-mode /dev/nvme0
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
Part of the nvme\-user suite\&.
|
