1MSTFLINT,(1) User Commands MSTFLINT,(1)
2
3
4
6 mstflint, - manual page for mstflint, mstflint 4.11.0, built on Nov 21
7 2018, 16:13:21. Git SHA Hash: N/A
8
10 NAME
11
12 MstFlint - Flash Interface
13
14 SYNOPSIS
15
16 MstFlint [OPTIONS] <command> [Parameters]
17
18 [-d|--device <device>] [-i|--image <image>] [-h|--help] [--hh]
19 [-y|--yes] [--no] [--guid <GUID>] [--guids <GUIDS...>] [--mac
20 <MAC>] [--macs <MACs...>] [--uid <UID>] [--blank_guids]
21 [--clear_semaphore] [--qq] [--nofs] [--allow_rom_change]
22 [--override_cache_replacement] [--no_flash_verify] [--use_fw]
23 [-s|--silent] [--vsd <string>] [--use_image_ps]
24 [--use_image_guids] [--use_image_rom] [--use_dev_rom]
25 [--ignore_dev_data] [--no_fw_ctrl] [--dual_image]
26 [--striped_image] [--banks <bank>] [--log <log_file>]
27 [--flash_params <type, log2size, num_of_flashes>] [-v|--version]
28 [--private_key <key_file>] [--key_uuid <uuid_file>] [--pri‐
29 vate_key2 <key_file>] [--hmac_key <hmac_key>] [--key_uuid2
30 <uuid_file>]
31
32 DESCRIPTION
33
34 flint is a FW (firmware) burning and flash memory operations
35 tool for Mellanox Infiniband HCAs,Ethernet NIC cards, and switch
36 devices.
37
38 OPTIONS
39
40 MstFlint [OPTIONS] <command> [Parameters]
41
42 -d|--device <device>
43 : Device flash is connected to. Commands affected: all
44
45 -i|--image <image>
46 : Binary image file. Commands affected: burn, verify
47
48 -h|--help
49 : Prints this message and exits
50
51 --hh : Prints extended command help
52
53 -y|--yes
54 : Non interactive mode - assume answer "yes" to all questions.
55 Commands affected: all
56
57 --no : Non interactive mode - assume answer "no" to all questions.
58 Commands affected: all
59
60 --guid <GUID>
61 : GUID base value. 4 GUIDs are automatically assigned to the
62 following values:
63
64 guid -> node GUID
65
66 guid+1 -> port1 guid+2 -> port2 guid+3 -> system image GUID.
67
68 Note: port2 guid will be assigned even for a single port HCA -
69 The HCA ignores this value.
70
71 Commands affected: burn, sg
72
73 --guids <GUIDS...>
74 : 4 GUIDs must be specified here. The specified GUIDs are
75 assigned to the following fields, respectively: node, port1,
76 port2 and system image GUID.
77
78 Note: port2 guid must be specified even for a single port HCA -
79 The HCA ignores this value. It can be set to 0x0.
80
81 Commands affected: burn, sg
82
83 --mac <MAC>
84 : MAC address base value. 2 MACs are automatically assigned to
85 the following values:
86
87 mac -> port1
88
89 mac+1 -> port2
90
91 Commands affected: burn, sg
92
93 --macs <MACs...>
94 : 2 MACs must be specified here. The specified MACs are
95 assigned to port1, port2, respectively. Commands affected:
96 burn, sg
97
98 Note: -mac/-macs flags are applicable only for Mellanox
99
100 Technologies ethernet products.
101
102 --uid <UID>
103 : ConnectIB/SwitchIB only. Derive and set the device UIDs
104 (GUIDs, MACs, WWNs). UIDs are derived from the given base UID
105 according to Mellanox Methodology Commands affected: burn, sg
106
107 --blank_guids
108 : Burn the image with blank GUIDs and MACs (where applicable).
109 These values can be set later using the "sg" command (see
110 details below).
111
112 Commands affected: burn
113
114 --clear_semaphore
115 : Force clear the flash semaphore on the device. No command is
116 allowed when this flag is used. NOTE: May result in system
117 instability or flash corruption if the device or another appli‐
118 cation is currently using the flash. Exercise caution.
119
120 --qq : Run a quick query. When specified, flint will not perform full
121 image integrity checks during the query operation. This may
122 shorten execution time when running over slow interfaces (e.g.,
123 I2C, MTUSB-1). Commands affected: query
124
125 --nofs : Burn image in a non failsafe manner.
126
127 --allow_rom_change
128 : Allow burning/removing a ROM to/from FW image when product
129 version is present. Use only if you know what you are doing
130
131 --override_cache_replacement
132 : On SwitchX/ConnectIB devices: Allow accessing the flash even
133 if the cache replacement mode is enabled. NOTE: This flag is
134 intended for advanced users only. Running in this mode may
135 cause the firmware to hang.
136
137 --no_flash_verify
138 : Do not verify each write on the flash.
139
140 --use_fw
141 : Flash access will be done using FW (ConnectX-3/ConnectX-3Pro
142 only).
143
144 -s|--silent
145 : Do not print burn progress flyer. Commands affected: burn
146
147 --vsd <string>
148 : Write this string, of up to 208 characters, to VSD when burn.
149
150 --use_image_ps
151 : Burn vsd as appears in the given image - do not keep existing
152 VSD on flash. Commands affected: burn
153
154 --use_image_guids
155 : Burn (guids/macs) as appears in the given image. Commands
156 affected: burn
157
158 --use_image_rom
159 : Do not save the ROM which exists in the device. Commands
160 affected: burn
161
162 --use_dev_rom
163 : Save the ROM which exists in the device. Commands affected:
164 burn
165
166 --ignore_dev_data
167 : Do not attempt to take device data sections from device(sec‐
168 tions will be taken from the image. FS3 Only). Commands
169 affected: burn
170
171 --no_fw_ctrl
172 : Do not attempt to work with the FW Ctrl update commands
173
174 --dual_image
175 : Make the burn process burn two images on flash (previously
176 default algorithm). Current default failsafe burn process burns
177 a single image (in alternating locations). Commands affected:
178 burn
179
180 --striped_image
181 : Use this flag to indicate that the given image file is in a
182 "striped image" format. Commands affected: query verify
183
184 --banks <bank>
185 : Set the number of attached flash devices (banks)
186
187 --log <log_file>
188 : Print the burning status to the specified log file
189
190 --flash_params <type, log2size,
191
192 num_of_flashes>
193 : Use the given parameters to access the flash
194
195 instead of reading them from the flash. Supported parameters:
196 Type: The type of the flash, such as:M25PXxx, M25Pxx, N25Q0XX,
197 SST25VFxx, W25QxxBV, W25Xxx, W25Qxxx, W25Qxxx, AT25DFxxx,
198 S25FLXXXP, S25FL11xx, MX25L16xxx, MX25Lxxx, S25FLxxx, IS25LPxxx.
199 log2size: The log2 of the flash size.num_of_flashes: the number
200 of the flashes connected to the device.
201
202 -v|--version
203 : Version info.
204
205 --private_key <key_file>
206 : path to PEM formatted private key to be used by the sign com‐
207 mand
208
209 --key_uuid <uuid_file>
210 : UUID matching the given private key to be used by the sign
211 command
212
213 --private_key2 <key_file>
214 : path to PEM formatted private key to be used by the sign com‐
215 mand
216
217 --hmac_key <hmac_key>
218 : path to file containing key (For FS4 image only).
219
220 --key_uuid2 <uuid_file>
221 : UUID matching the given private key to be used by the sign
222 command
223
224 COMMANDS SUMMARY
225
226 burn|b : Burn flash
227
228 query|q [full]
229 : Query misc. flash/firmware characteristics,
230
231 use "full" to get more information.
232
233 verify|v [showitoc]
234 : Verify entire flash, use "showitoc" to see
235
236 ITOC headers in FS3/FS4 image only.
237
238 swreset
239 : SW reset the target switch device.This
240
241 command is supported only in the In-Band access method.
242
243 brom <ROM-file> : Burn the specified ROM
244 file on the flash.
245
246 drom : Remove the ROM section from the flash.
247
248 rrom <out-file> : Read the ROM section
249 from the flash.
250
251 bb : Burn Block - Burns the given image as is. No
252
253 checks are done.
254
255 sg [guids_num=<num|num_port1,num_port2>
256
257 step_size=<size|size_port1,size_port2>] | [nocrc]
258 : Set GUIDs. sv : Set
259 the VSD. ri <out-file> : Read
260 the fw image on the flash. dc [out-file]
261 : Dump Configuration: print fw configuration
262
263 file for the given image.
264
265 dh [out-file] : Dump Hash: dump the
266 hash if it is integrated
267
268 in the FW image
269
270 set_key
271 [key] : Set/Update the HW access
272 key which is used to
273
274 enable/disable access to HW. The key can be provided in the
275 command line or interactively typed after the command is given
276 NOTE: The new key is activated only after the device is reset.
277
278 hw_access
279 <enable|disable> [key] : Enable/disable the access to
280 the HW.
281
282 The key can be provided in the command line or interactively
283 typed after the command is given
284
285 hw query : Query HW info and
286 flash attributes.
287
288 erase|e <addr>
289 : Erases sector.
290
291 rw <addr> : Read one dword from
292 flash
293
294 ww <addr> <data> : Write one dword to
295 flash
296
297 wwne <addr> <data> : Write one dword to flash
298 without sector
299
300 erase
301
302 wbne <addr> <size> <data ...> : Write a data block to
303 flash without sector
304
305 erase.
306
307 wb <data-file> <addr> : Write a data block to
308 flash.
309
310 rb <addr> <size> [out-file] : Read a data block
311 from flash
312
313 clear_semaphore
314 : Clear flash semaphore.
315
316 qrom : query ROM image.
317
318 checksum|cs
319 : perform MD5 checksum on FW.
320
321 timestamp|ts <set|query|reset> [timestamp] [FW version]
322 : FW time stamping. cache_image|ci
323 : cache FW image(Windows only). sign
324 : Sign firmware image file sign_with_hmac
325 : Sign image with HMAC set_public_keys [public keys binary
326 file] : Set Public Keys (For FS3/FS4 image only). set_forbid‐
327 den_versions [forbidden versions binary file]
328 : Set Forbidden Versions (For FS3/FS4 image
329
330 only).
331
332 RETURN VALUES
333
334 0 : Successful completion.
335
336 1 : An error has occurred.
337
338 7 : For burn command - FW already updated - burn
339
340 was aborted.
341
343 The full documentation for mstflint, is maintained as a Texinfo manual.
344 If the info and mstflint, programs are properly installed at your site,
345 the command
346
347 info mstflint,
348
349 should give you access to the complete manual.
350
351
352
353mstflint, mstflint 4.11.0, built oNnovNeomvbe2r122001188, 16:13:21. Git SHAMHSaTsFhL:INNT/,A(1)