1MSTFLINT,(1)                     User Commands                    MSTFLINT,(1)
2
3
4

NAME

6       mstflint,  - manual page for mstflint, mstflint 4.14.0, built on Mar  3
7       2020, 14:02:39. Git SHA Hash: N/A
8

DESCRIPTION

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

SEE ALSO

371       The full documentation for mstflint, is maintained as a Texinfo manual.
372       If the info and mstflint, programs are properly installed at your site,
373       the command
374
375              info mstflint,
376
377       should give you access to the complete manual.
378
379
380
381mstflint, mstflint 4.14.0, built onMaMracrh 230220020, 14:02:39. Git SHAMHSaTsFhL:INNT/,A(1)
Impressum