summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-lnvm-factory.1
blob: fb0a70bffb0108a5ed60740a3ad350407d215ad9 (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
'\" t
.\"     Title: nvme-lnvm-factory
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/24/2020
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-LNVM\-FACTORY" "1" "04/24/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-factory \- Factory reset a LightNVM device
.SH "SYNOPSIS"
.sp
.nf
\fInvme lnvm\-factory\fR [\-\-device\-name=<DEVICE> | \-d <DEVICE>]
                        [\-\-erase\-only\-marked | \-e]
                        [\-\-clear\-host\-side\-blks | \-s]
                        [\-\-clear\-bb\-blks | \-b]
.fi
.SH "DESCRIPTION"
.sp
Instantiate a target on top of a LightNVM enabled device\&. This exposes the physical for the user to use\&.
.SH "OPTIONS"
.PP
\-\-device\-name=<DEVICE>, \-d <DEVICE>
.RS 4
Device name to factory initialize
.RE
.PP
\-\-erase\-only\-marked, \-e
.RS 4
Erases only blocks that are marked in the bad block list
.RE
.PP
\-\-clear\-host\-side\-blks, \-s
.RS 4
Remove host\-side bad block marks\&. This clear the media manager registration
.RE
.PP
\-\-clear\-bb\-blks, \-b
.RS 4
Removes the grown bad block marks\&. Allowing them to be rediscovered\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Factory reset of device nvme0n1
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme lnvm\-factory \-d nvme0n1
.fi
.if n \{\
.RE
.\}
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Complete factory reset of device nvme0n1
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme lnvm\-factory \-d nvme0n1 \-s \-b
.fi
.if n \{\
.RE
.\}
.SH "NVME"
.sp
Part of the nvme\-user suite