summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-micron-selective-download.1
blob: 44780401981a2754e1cfb83b0753d61e973cdb0c (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
138
139
140
'\" t
.\"     Title: nvme-micron-selective-download
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 08/05/2024
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-MICRON\-SELECT" "1" "08/05/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-micron-selective-download \- Performs selective firmware download that allows user select which firmware binary to update for 9200 devices\&. This requires power cycle the update completes\&.
.SH "SYNOPSIS"
.sp
.nf
\fInvme micron selective\-download\fR <device> [\-\-fw=<FILE>, \-f <FILE>]
                        [\-\-select=<flag>, \-s <flag>]
.fi
.SH "DESCRIPTION"
.sp
This command uses micron vendor specific nvme commands to download given firmware image to the 9200 device to update selected or all portions of firmware image\&.
.sp
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
.sp
This will only work on Micron devices devices of model number 9200\&. Support for new devices be added subsequently\&. Results for any other device are undefined\&.
.SH "OPTIONS"
.PP
\-f <FILE>, \-\-fw=<FILE>
.RS 4
name of the firmware image file
.RE
.PP
\-s <flag>, \-\-select=<flag>
.RS 4
flag that has following values
.RE
.PP
OOB
.RS 4
This updates the OOB and main firmware\en"
.RE
.PP
EEP
.RS 4
This updates the eeprom and main firmware\en"
.RE
.PP
ALL
.RS 4
This updates the eeprom, OOB, and main firmware";
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Update OOB and main firmware
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme micron selective\-download /dev/nvme0 \-\-fw=firmware_bin \-\-select=OOB
# nvme micron selective\-download /dev/nvme0 \-f firmware_bin \-s OOB
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Update OOB and main firmware
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme micron selective\-download /dev/nvme0 \-\-fw=firmware_bin \-\-select=EEP
# nvme micron selective\-download /dev/nvme0 \-f firmware_bin \-\-s EEP
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Update eeprom, OOB and main firmware
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme micron selective\-download /dev/nvme0 \-\-fw=firmware_bin \-\-select=ALL
# nvme micron selective\-download /dev/nvme0 \-f firmware_bin \-\-s ALL
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
Part of the nvme\-user suite