summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-lnvm-diag-bbtbl.1
blob: 398dc809098257a4027ec417187d6fab75f60d03 (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
'\" t
.\"     Title: nvme-lnvm-diag-bbtbl
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 10/20/2020
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-LNVM\-DIAG\-BB" "1" "10/20/2020" "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-lnvm-diag-bbtbl \- Diagnose the bad block table
.SH "SYNOPSIS"
.sp
.nf
\fInvme lnvm\-diag\-bbtbl\fR [\-\-namespace\-id=<NUM> | \-n <NUM>]
                        [\-\-channel\-id=<CHID> | \-c <CHID>]
                        [\-\-lun\-id=<LUNID> | \-l <LUNID>]
                        [\-\-raw\-binary | \-b]
.fi
.SH "DESCRIPTION"
.sp
Retrieve the bad block table for a given channel and lun\&.
.sp
The statistics will be shown in the default case, and the actual output bad block information can be retrieved when \-\-raw\-binary is passed\&.
.sp
The raw binary output follows this format:
.sp
Channel 0, LUN0 (Dual plane flash)
.sp
Byte 0 \(-> Plane 0, Block 0 Byte 1 \(-> Plane 1, Block 0 Byte 2 \(-> Plane 0, Block 1 \&...
.SH "OPTIONS"
.PP
\-\-namespace\-id=<NUM>, \-n <NUM>
.RS 4
Namespace id to use
.RE
.PP
\-\-channel\-id=<NUM>, \-c
.RS 4
Channel id
.RE
.PP
\-\-lun\-id=<NUM>, \-l
.RS 4
LUN id
.RE
.PP
\-\-raw\-binary, \-b
.RS 4
Returns the bad block table in binary form without statistics\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Retrieve bad block table statistics for physical device nvme0, channel 0, and lun 0:
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme lnvm\-diag\-bbtbl /dev/nvme0 \-c 0 \-n 0
.fi
.if n \{\
.RE
.\}
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Display the bad block table in raw form without statistics for same query:
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme lnvm\-diag\-bbtbl /dev/nvme0 \-c 0 \-n 0 \-b | hexdump
.fi
.if n \{\
.RE
.\}
.SH "NVME"
.sp
Part of the nvme\-user suite