1MSTFLINT(1) User Commands MSTFLINT(1)
2
6 mstflint - Flash Interface
7
9 NAME mstflint - Flash Interface
10
12 mstflint [OPTIONS] <command> [Parameters]
13 [-d|--device <device>] [-i|--image <image>] [--latest_fw] [--ir]
15 [-h|--help] [--hh] [-y|--yes] [--no] [--guid <GUID>] [--guids
16 <GUIDS...>] [--mac <MAC>] [--macs <MACs...>] [--uid <UID>]
17 [--blank_guids] [--clear_semaphore] [--qq] [--low_cpu]
18 [--flashed_version] [--nofs] [--allow_rom_change] [--over‐
19 ride_cache_replacement] [--no_flash_verify] [--use_fw]
20 [-s|--silent] [--vsd <string>] [--use_image_ps] [--use_im‐
21 age_guids] [--use_image_rom] [--use_dev_rom] [--ignore_dev_data]
22 [--no_fw_ctrl] [--dual_image] [--striped_image] [--banks <bank>]
23 [--log <log_file>] [--flash_params <type, log2size,
24 num_of_flashes>] [-v|--version] [--private_key <key_file>]
25 [--key_uuid <uuid_file>] [--private_key2 <key_file>] [--hmac_key
26 <hmac_key>] [--key_uuid2 <uuid_file>]
27 DESCRIPTION
29 flint is a FW (firmware) burning and flash memory operations
31 tool for Mellanox Infiniband HCAs,Ethernet NIC cards, and switch
32 devices.
33
35 -d|--device <device>
36 Device flash is connected to. Commands affected: all
37 -i|--image <image>
39 Binary image file. Commands affected: burn, verify
40 --latest_fw
42 : Commands affected: burn
43 --ir : Commands affected: burn
45 -h|--help
47 Prints this message and exits
48 --hh Prints extended command help
50 -y|--yes
52 Non interactive mode - assume answer "yes" to all questions.
53 Commands affected: all
54 --no Non interactive mode - assume answer "no" to all questions.
56 Commands affected: all
57 --guid <GUID>
59 GUID base value. 4 GUIDs are automatically assigned to the fol‐
60 lowing values:
61 guid -> node GUID
63 guid+1 -> port1
65 guid+2 -> port2 guid+3 -> system image GUID.
66 Note: port2 guid will be assigned even for a
68 single port HCA - The HCA ignores this value.
69 Commands affected: burn, sg
71 --guids <GUIDS...>
73 4 GUIDs must be specified here. The specified GUIDs are as‐
74 signed to the following fields, respectively: node, port1, port2
75 and system image GUID.
76 Note: port2 guid must be specified even for
78 a single port HCA - The HCA ignores this value. It can be set
79 to 0x0.
80 Commands affected: burn, sg
82 --mac <MAC>
84 MAC address base value. 2 MACs are automatically assigned to the
85 following values:
86 mac -> port1
88 mac+1 -> port2
90 Commands affected: burn, sg
92 --macs <MACs...>
94 2 MACs must be specified here. The specified MACs are assigned
95 to port1, port2, respectively. Commands affected: burn, sg
96 Note: -mac/-macs flags are applicable only
98 for Mellanox
99 Technologies ethernet products.
101 --uid <UID>
103 ConnectIB/SwitchIB only. Derive and set the device UIDs (GUIDs,
104 MACs, WWNs). UIDs are derived from the given base UID according
105 to Mellanox Methodology Commands affected: burn, sg
106 --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 de‐
110 tails below).
111 Commands affected: burn
113 --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 in‐
117 stability or flash corruption if the device or another applica‐
118 tion is currently using the flash. Exercise caution.
119 --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 --low_cpu
126 : When specified, cpu usage will be reduced. Run time might be
127 increased Commands affected: query
128 --flashed_version
130 : When specified, only flashed fw version is fetched Commands
131 affected: query
132 --nofs Burn image in a non failsafe manner.
134 --allow_rom_change
136 Allow burning/removing a ROM to/from FW image when product ver‐
137 sion is present. Use only if you know what you are doing
138 --override_cache_replacement
140 On SwitchX/ConnectIB devices: Allow accessing the flash even if
141 the cache replacement mode is enabled. NOTE: This flag is in‐
142 tended for advanced users only. Running in this mode may cause
143 the firmware to hang.
144 --no_flash_verify
146 Do not verify each write on the flash.
147 --use_fw
149 Flash access will be done using FW (ConnectX-3/ConnectX-3Pro
150 only).
151 -s|--silent
153 Do not print burn progress flyer. Commands affected: burn
154 --vsd <string>
156 Write this string, of up to 208 characters, to VSD when burn.
157 --use_image_ps
159 Burn vsd as appears in the given image - do not keep existing
160 VSD on flash. Commands affected: burn
161 --use_image_guids
163 Burn (guids/macs) as appears in the given image. Commands af‐
164 fected: burn
165 --use_image_rom
167 Do not save the ROM which exists in the device. Commands af‐
168 fected: burn
169 --use_dev_rom
171 Save the ROM which exists in the device. Commands affected:
172 burn
173 --ignore_dev_data
175 Do not attempt to take device data sections from device(sections
176 will be taken from the image. FS3 Only). Commands affected:
177 burn
178 --no_fw_ctrl
180 Do not attempt to work with the FW Ctrl update commands
181 --dual_image
183 Make the burn process burn two images on flash (previously de‐
184 fault algorithm). Current default failsafe burn process burns a
185 single image (in alternating locations). Commands affected:
186 burn
187 --striped_image
189 Use this flag to indicate that the given image file is in a
190 "striped image" format. Commands affected: query verify
191 --banks <bank>
193 Set the number of attached flash devices (banks)
194 --log <log_file>
196 Print the burning status to the specified log file
197 --flash_params <type, log2size,
199 num_of_flashes>
201 Use the given parameters to access the flash
202 instead of reading them from the flash.
204 Supported parameters: Type: The type of the flash, such
205 as:M25PXxx, M25Pxx, N25Q0XX, SST25VFxx, W25QxxBV, W25Xxx,
206 W25Qxxx, W25Qxxx, AT25DFxxx, S25FLXXXP, S25FL11xx, MX25L16xxx,
207 MX25Lxxx, S25FLxxx, IS25LPxxx. log2size: The log2 of the flash
208 size.num_of_flashes: the number of the flashes connected to the
209 device.
210 -v|--version
212 Version info.
213 --private_key <key_file>
215 path to PEM formatted private key to be used by the sign command
216 --key_uuid <uuid_file>
218 UUID matching the given private key to be used by the sign com‐
219 mand
220 --private_key2 <key_file>
222 path to PEM formatted private key to be used by the sign command
223 --hmac_key <hmac_key>
225 path to file containing key (For FS4 image only).
226 --key_uuid2 <uuid_file>
228 UUID matching the given private key to be used by the sign com‐
229 mand
230 COMMANDS SUMMARY
232 burn|b -ir
234 Burn flash. Use "-ir burn" flag to perform
235 image reactivation prior burning.
237 query|q [full]
239 Query misc. flash/firmware characteristics,
240 use "full" to get more information.
242 verify|v [showitoc]
244 Verify entire flash, use "showitoc" to see
245 ITOC headers in FS3/FS4 image only.
247 swreset
249 SW reset the target switch device.This
250 command is supported only in the In-Band access method.
252 brom <ROM-file> : Burn the specified ROM
254 file on the flash.
255 drom Remove the ROM section from the flash.
257 rrom <out-file> : Read the ROM section
259 from the flash.
260 bb Burn Block - Burns the given image as is. No
262 checks are done.
264 sg [guids_num=<num|num_port1,num_port2>
266 step_size=<size|size_port1,size_port2>] | [nocrc]
268 : Set GUIDs. sv : Set
269 the VSD. ri <out-file> : Read
270 the fw image on the flash. dc [out-file]
271 : Dump Configuration: print fw configuration
272 file for the given image.
274 dh [out-file] : Dump Hash: dump the
276 hash if it is integrated
277 in the FW image
279 set_key
281 [key] : Set/Update the HW access
282 key which is used to
283 enable/disable access to HW.
285 The key can be provided in the command line or interactively
286 typed after the command is given NOTE: The new key is activated
287 only after the device is reset.
288 hw_access
290 <enable|disable> [key] : Enable/disable the access to
291 the HW.
292 The key can be provided in the command line
294 or interactively typed after the command is given
295 hw query : Query HW info and
297 flash attributes.
298 erase|e <addr>
300 Erases sector.
301 rw <addr> : Read one dword from
303 flash
304 ww <addr> <data> : Write one dword to
306 flash
307 wwne <addr> <data> : Write one dword to flash
309 without sector
310 erase
312 wbne <addr> <size> <data ...> : Write a data block to
314 flash without sector
315 erase.
317 wb <data-file> <addr> : Write a data block to
319 flash.
320 rb <addr> <size> [out-file] : Read a data block
322 from flash
323 clear_semaphore
325 Clear flash semaphore.
326 qrom query ROM image.
328 checksum|cs
330 perform MD5 checksum on FW.
331 timestamp|ts <set|query|reset> [timestamp] [FW version]
333 : FW time stamping. cache_image|ci
334 : cache FW image(Windows only). sign
335 : Sign firmware image file sign_with_hmac
336 : Sign image with HMAC set_public_keys [public keys binary
337 file] : Set Public Keys (For FS3/FS4 image only). set_forbid‐
338 den_versions [forbidden versions binary file]
339 : Set Forbidden Versions (For FS3/FS4 image
340 only).
342 image_reactivate|ir
344 : Reactivate previous flash image. For FW
345 controlled devices only.
347 binary_compare|bc
349 : Binary compare between device firmware and
350 given BIN file. If there is a silent mode, no progress is dis‐
352 played.
353
355 0 Successful completion.
356 1 An error has occurred.
358 7 For burn command - FW already updated - burn was aborted.
360
362 mstarchive(1)
363mstflint March 2020 MSTFLINT(1)