blob: 33ed0aefeeb4e001d6dbafa0e8fa7f39676f246a (
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
|
'\" t
.\" Title: nvme-wdc-vs-error-reason-identifier
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 06/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-WDC\-VS\-ERROR" "1" "06/30/2023" "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-wdc-vs-error-reason-identifier \- Retrieve WDC device\*(Aqs telemetry log error reason identifier field
.SH "SYNOPSIS"
.sp
.nf
\fInvme wdc vs\-error\-reason\-identifier\fR <device> [\-\-log\-id=<NUM>, \-i <NUM>] [\-\-file=<FILE>, \-o <FILE>]
.fi
.SH "DESCRIPTION"
.sp
For the NVMe device given, retrieve the telemetry log error reason id field for either the host generated or controller initiated log\&. The controller initiated telemetry log page option must be enabled to retrieve the error reason id for that log page id\&.
.sp
The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0)\&.
.sp
This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&.
.sp
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
\-i <id>, \-\-log\-id=<id>
.RS 4
Specifies the telemetry log id of the error reason identifier to retrieve\&. Use id 7 for the host generated log page\&. Use id 8 for the controller initiated log page\&. The default is 7/host generated
.RE
.PP
\-o <FILE>, \-\-output\-file=<FILE>
.RS 4
Output file; defaults to "<device serial number>_error_reason_identifier_host_<date>_<time>\&.bin" for the host generated log or "<device serial number>_error_reason_identifier_ctlr_<date>_<time>\&.bin" for the controller initiated log\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Retrieves the host generated error reason identifier field and save it in file host_gen_error_reason_id\&.bin\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme wdc vs\-error\-reason\-identifier /dev/nvme0 \-i 7 \-o host_gen_error_reason_id\&.bin
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Retrieves the controller initiated error reason identifier field and save it in file ctlr_init_error_reason_id\&.bin\&.
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme wdc vs\-error\-reason\-identifier /dev/nvme0 \-i 8 \-o ctlr_init_error_reason_id\&.bin
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
Part of the nvme\-user suite\&.
|
