diff options
Diffstat (limited to 'man/mstflint.1')
| -rw-r--r-- | man/mstflint.1 | 138 |
1 files changed, 67 insertions, 71 deletions
diff --git a/man/mstflint.1 b/man/mstflint.1 index 28addcf..b604e02 100644 --- a/man/mstflint.1 +++ b/man/mstflint.1 @@ -1,15 +1,14 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.41.1. .TH MSTFLINT, "1" "March 2020" "mstflint, mstflint 4.14.0, built on Mar 3 2020, 14:02:39. Git SHA Hash: N/A" "User Commands" .SH NAME -mstflint, \- manual page for mstflint, mstflint 4.14.0, built on Mar 3 2020, 14:02:39. Git SHA Hash: N/A +mstflint \- Flash Interface .SH DESCRIPTION NAME -.IP -MstFlint \- Flash Interface -.PP +mstflint \- Flash Interface +.SH SYNOPSIS .IP -MstFlint [OPTIONS] <command> [Parameters] +mstflint [OPTIONS] <command> [Parameters] .IP [\-d|\-\-device <device>] [\-i|\-\-image <image>] [\-\-latest_fw] [\-\-ir] [\-h|\-\-help] [\-\-hh] [\-y|\-\-yes] [\-\-no] [\-\-guid <GUID>] [\-\-guids <GUIDS...>] [\-\-mac <MAC>] @@ -27,17 +26,15 @@ DESCRIPTION .IP flint is a FW (firmware) burning and flash memory operations tool for Mellanox Infiniband HCAs,Ethernet NIC cards, and switch devices. -.PP +.SH OPTIONS -.IP -MstFlint [OPTIONS] <command> [Parameters] .TP \fB\-d\fR|\-\-device <device> -: Device flash is connected to. +Device flash is connected to. Commands affected: all .TP \fB\-i\fR|\-\-image <image> -: Binary image file. +Binary image file. Commands affected: burn, verify .TP \fB\-\-latest_fw\fR @@ -47,32 +44,32 @@ Commands affected: burn, verify : Commands affected: burn .TP \fB\-h\fR|\-\-help -: Prints this message and exits +Prints this message and exits .TP \fB\-\-hh\fR -: Prints extended command help +Prints extended command help .TP \fB\-y\fR|\-\-yes -: Non interactive mode \- assume answer "yes" to +Non interactive mode \- assume answer "yes" to all questions. Commands affected: all .TP \fB\-\-no\fR -: Non interactive mode \- assume answer "no" to +Non interactive mode \- assume answer "no" to all questions. Commands affected: all .TP \fB\-\-guid\fR <GUID> -: GUID base value. 4 GUIDs are automatically +GUID base value. 4 GUIDs are automatically assigned to the following values: .TP guid \-> node GUID -.IP +.TP guid+1 \-> port1 guid+2 \-> port2 guid+3 \-> system image GUID. -.IP +.TP Note: port2 guid will be assigned even for a single port HCA \- The HCA ignores this value. @@ -80,11 +77,11 @@ value. Commands affected: burn, sg .TP \fB\-\-guids\fR <GUIDS...> -: 4 GUIDs must be specified here. +4 GUIDs must be specified here. The specified GUIDs are assigned to the following fields, respectively: node, port1, port2 and system image GUID. -.IP +.TP Note: port2 guid must be specified even for a single port HCA \- The HCA ignores this value. @@ -93,7 +90,7 @@ It can be set to 0x0. Commands affected: burn, sg .TP \fB\-\-mac\fR <MAC> -: MAC address base value. 2 MACs are +MAC address base value. 2 MACs are automatically assigned to the following values: .TP @@ -106,25 +103,25 @@ mac+1 Commands affected: burn, sg .TP \fB\-\-macs\fR <MACs...> -: 2 MACs must be specified here. +2 MACs must be specified here. The specified MACs are assigned to port1, port2, respectively. Commands affected: burn, sg -.IP +.TP Note: \fB\-mac\fR/\-macs flags are applicable only for Mellanox .IP Technologies ethernet products. .TP \fB\-\-uid\fR <UID> -: ConnectIB/SwitchIB only. Derive and set the +ConnectIB/SwitchIB only. Derive and set the device UIDs (GUIDs, MACs, WWNs). UIDs are derived from the given base UID according to Mellanox Methodology Commands affected: burn, sg .TP \fB\-\-blank_guids\fR -: Burn the image with blank GUIDs and MACs +Burn the image with blank GUIDs and MACs (where applicable). These values can be set later using the "sg" command (see details below). @@ -132,7 +129,7 @@ below). Commands affected: burn .TP \fB\-\-clear_semaphore\fR -: Force clear the flash semaphore on the +Force clear the flash semaphore on the device. No command is allowed when this flag is used. @@ -142,7 +139,7 @@ application is currently using the flash. Exercise caution. .TP \fB\-\-qq\fR -: Run a quick query. When specified, flint will +Run a quick query. When specified, flint will not perform full image integrity checks during the query operation. This may shorten execution time when running over slow @@ -160,15 +157,15 @@ fetched Commands affected: query .TP \fB\-\-nofs\fR -: Burn image in a non failsafe manner. +Burn image in a non failsafe manner. .TP \fB\-\-allow_rom_change\fR -: Allow burning/removing a ROM to/from FW image +Allow burning/removing a ROM to/from FW image when product version is present. Use only if you know what you are doing .TP \fB\-\-override_cache_replacement\fR -: On SwitchX/ConnectIB devices: +On SwitchX/ConnectIB devices: Allow accessing the flash even if the cache replacement mode is enabled. NOTE: This flag is intended for advanced @@ -177,74 +174,74 @@ Running in this mode may cause the firmware to hang. .TP \fB\-\-no_flash_verify\fR -: Do not verify each write on the flash. +Do not verify each write on the flash. .TP \fB\-\-use_fw\fR -: Flash access will be done using FW +Flash access will be done using FW (ConnectX\-3/ConnectX\-3Pro only). .TP \fB\-s\fR|\-\-silent -: Do not print burn progress flyer. +Do not print burn progress flyer. Commands affected: burn .TP \fB\-\-vsd\fR <string> -: Write this string, of up to 208 characters, +Write this string, of up to 208 characters, to VSD when burn. .TP \fB\-\-use_image_ps\fR -: Burn vsd as appears in the given image \- do +Burn vsd as appears in the given image \- do not keep existing VSD on flash. Commands affected: burn .TP \fB\-\-use_image_guids\fR -: Burn (guids/macs) as appears in the given +Burn (guids/macs) as appears in the given image. Commands affected: burn .TP \fB\-\-use_image_rom\fR -: Do not save the ROM which exists in the +Do not save the ROM which exists in the device. Commands affected: burn .TP \fB\-\-use_dev_rom\fR -: Save the ROM which exists in the device. +Save the ROM which exists in the device. Commands affected: burn .TP \fB\-\-ignore_dev_data\fR -: Do not attempt to take device data sections +Do not attempt to take device data sections from device(sections will be taken from the image. FS3 Only). Commands affected: burn .TP \fB\-\-no_fw_ctrl\fR -: Do not attempt to work with the FW Ctrl +Do not attempt to work with the FW Ctrl update commands .TP \fB\-\-dual_image\fR -: Make the burn process burn two images on +Make the burn process burn two images on flash (previously default algorithm). Current default failsafe burn process burns a single image (in alternating locations). Commands affected: burn .TP \fB\-\-striped_image\fR -: Use this flag to indicate that the given +Use this flag to indicate that the given image file is in a "striped image" format. Commands affected: query verify .TP \fB\-\-banks\fR <bank> -: Set the number of attached flash devices +Set the number of attached flash devices (banks) .TP \fB\-\-log\fR <log_file> -: Print the burning status to the specified log +Print the burning status to the specified log file .HP \fB\-\-flash_params\fR <type, log2size, .TP num_of_flashes> -: Use the given parameters to access the flash -.IP +Use the given parameters to access the flash +.TP instead of reading them from the flash. Supported parameters: Type: The type of the flash, such @@ -257,47 +254,47 @@ size.num_of_flashes: the number of the flashes connected to the device. .TP \fB\-v\fR|\-\-version -: Version info. +Version info. .TP \fB\-\-private_key\fR <key_file> -: path to PEM formatted private key to be used +path to PEM formatted private key to be used by the sign command .TP \fB\-\-key_uuid\fR <uuid_file> -: UUID matching the given private key to be +UUID matching the given private key to be used by the sign command .TP \fB\-\-private_key2\fR <key_file> -: path to PEM formatted private key to be used +path to PEM formatted private key to be used by the sign command .TP \fB\-\-hmac_key\fR <hmac_key> -: path to file containing key (For FS4 image +path to file containing key (For FS4 image only). .TP \fB\-\-key_uuid2\fR <uuid_file> -: UUID matching the given private key to be +UUID matching the given private key to be used by the sign command .PP COMMANDS SUMMARY .TP burn|b \fB\-ir\fR -: Burn flash. Use "\-ir burn" flag to perform +Burn flash. Use "\-ir burn" flag to perform .IP image reactivation prior burning. .TP query|q [full] -: Query misc. flash/firmware characteristics, +Query misc. flash/firmware characteristics, .IP use "full" to get more information. .TP verify|v [showitoc] -: Verify entire flash, use "showitoc" to see +Verify entire flash, use "showitoc" to see .IP ITOC headers in FS3/FS4 image only. .TP swreset -: SW reset the target switch device.This +SW reset the target switch device.This .IP command is supported only in the In\-Band access method. @@ -306,13 +303,13 @@ brom <ROM\-file> : Burn the specified ROM file on the flash. .TP drom -: Remove the ROM section from the flash. +Remove the ROM section from the flash. .TP rrom <out\-file> : Read the ROM section from the flash. .TP bb -: Burn Block \- Burns the given image as is. No +Burn Block \- Burns the given image as is. No .IP checks are done. .TP @@ -334,7 +331,7 @@ in the FW image .TP set_key [key] : Set/Update the HW access key which is used to -.IP +.TP enable/disable access to HW. The key can be provided in the command line or interactively typed after the command is @@ -344,7 +341,7 @@ the device is reset. .TP hw_access <enable|disable> [key] : Enable/disable the access to the HW. -.IP +.TP The key can be provided in the command line or interactively typed after the command is given @@ -353,7 +350,7 @@ hw query : Query HW info and flash attributes. .TP erase|e <addr> -: Erases sector. +Erases sector. .TP rw <addr> : Read one dword from flash @@ -378,13 +375,13 @@ rb <addr> <size> [out\-file] : Read a data block from flash .TP clear_semaphore -: Clear flash semaphore. +Clear flash semaphore. .TP qrom -: query ROM image. +query ROM image. .TP checksum|cs -: perform MD5 checksum on FW. +perform MD5 checksum on FW. .IP timestamp|ts <set|query|reset> [timestamp] [FW version] : FW time stamping. @@ -407,28 +404,27 @@ binary_compare|bc .IP given BIN file. If there is a silent mode, no progress is displayed. -.PP +.SH RETURN VALUES .TP 0 -: Successful completion. +Successful completion. .TP 1 -: An error has occurred. +An error has occurred. .TP 7 -: For burn command \- FW already updated \- burn -.IP +For burn command \- FW already updated \- burn was aborted. .SH "SEE ALSO" The full documentation for -.B mstflint, +.B mstflint is maintained as a Texinfo manual. If the .B info and -.B mstflint, +.B mstflint programs are properly installed at your site, the command .IP -.B info mstflint, +.B info mstflint .PP should give you access to the complete manual. |