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