Mellanox / mstflint

Mstflint - an open source version of MFT (Mellanox Firmware Tools)
Other
176 stars 93 forks source link

old program names used in the help messages #9

Closed ghost closed 6 years ago

ghost commented 6 years ago

mstfwmanager/mstfwreset help text mentions the mlx utilities (mlxfwmanager/mlxfwreset). These should be updated to use the mst utility names instead.

mstflint]# /usr/bin/mstfwreset --help usage: mlxfwreset -d|--device DEVICE [-l|--level {0,1,2,3,4,5}] [--yes] q|query|r|reset [--help] [--version]

Mlxfwreset : Tool which provides the following functionality:

  1. Query device for reset level required in order to load new firmware
  2. Perform reset operation in order to load new firmware

Options: --device DEVICE, -d DEVICE Device to work with. --level {0,1,2,3,4,5}, -l {0,1,2,3,4,5} Run reset with the specified reset level. --yes, -y answer "yes" on prompt. --skip_driver, -s Skip driver start/stop stage (driver must be stopped manually). --mst_flags MST_FLAGS, -m MST_FLAGS Provide mst flags to be used when invoking mst restart step. For example: --mst_flags="--with_fpga" --version, -v Print tool version. --help, -h show this help message and exit. --skip_fsm_sync Skip fsm syncing

Commands: {q,query,r,reset,reset_fsm_register} query: Query reset Level. reset: Execute reset. reset_fsm_register: Reset the fsm register.

Reset levels: 0: Full ISFU. 1: Driver restart (link/managment will remain up). 2: Driver restart (link/managment will be down). 3: Driver restart and PCI reset. 4: Warm reboot. 5: Cold reboot (performed by the user).

Supported Devices: ConnectIB, ConnectX4, ConnectX4LX, ConnectX5, BlueField.

mstflint]# /usr/bin/mstfwmanager --help NAME mlxfwmanager

SYNOPSIS mlxfwmanager [-d|--dev DeviceName] [-h|--help] [-v|--version] [--query] [--query-format Format] [-u|--update] [-i|--image-file FileName] [-D|--image-dir DirectoryName] [-f|--force] [--no_fw_ctrl] [-y|--yes] [--no] [--clear-semaphore] [--exe-rel-path] [-l|--list-content] [--archive-names] [--nofs] [--log] [-L|--log-file LogFileName] [--no-progress] [-o|--outfile OutputFileName] [--online] [--online-query-psid PSIDs] [--key key] [--download DirectoryName] [--download-default] [--get-download-opt OPT] [--download-device Device] [--download-os OS] [--download-type Type] [--ssl-certificate Certificate]

DESCRIPTION Mellanox Firmware Manager

OPTIONS mlxfwmanager -d|--dev DeviceName : Perform operation for specified mst device(s). Run 'mst status' command to list the available devices. Multiple devices can be specified delimited by semicolons. A device list containing semicolons must be quoted. -h|--help : Show this message and exit -v|--version : Show the executable version and exit --query : Query device(s) info --query-format Format : (Query | Online query) output format, XML | Text - default Text -u|--update : Update firmware image(s) on the device(s) -i|--image-file FileName : Specified image file to use -D|--image-dir DirectoryName : Specified directory instead of default to locate image files -f|--force : Force image update --no_fw_ctrl : Don't use FW Ctrl update -y|--yes : Answer is yes in prompts --no : Answer is no in prompts --clear-semaphore : Force clear the flash semaphore on the device, No command is allowed when this flag is used. NOTE: May result in system instability or flash corruption if the device or another application is currently using the flash. Exercise caution. --exe-rel-path : Use paths relative to the location of the executable -l|--list-content : List file/Directory content, used with --image-dir and --image-file flags --archive-names : Display archive names in listing --nofs : Burn image in a non failsafe manner --log : Create log file -L|--log-file LogFileName : Use specified log file --no-progress : Do not show progress -o|--outfile OutputFileName : Write to specified output file --online : Fetch required FW images online from Mellanox server --online-query-psid PSIDs : Query FW info, PSID(s) are comma separated --key key : Key for custom download/update --download DirectoryName : Download files from server to a specified directory --download-default : Use Default values for download --get-download-opt OPT : Get download options for OS or Device Options are: OS, Device --download-device Device : Use '--get-download-opt Device' option to view available devices for device specific downloads --download-os OS : Only for self_extractor download: Use '--get-download-opt OS' option to view available OS for sfx download --download-type Type : MFA | self_extractor - default All --ssl-certificate Certificate : SSL certificate For secure connection

Examples:

  1. Query specific device or all devices (if no device were supplied)

    mlxfwmanager [-d ] [--query]

  2. Burn device with specific image / MFA / images directory

    mlxfwmanager -d [-i <image file/MFA file> | -D ]

  3. Update the card's firmware

    mlxfwmanager -u

  4. Update the card's firmware from latest version on the web

    mlxfwmanager --online -u

  5. Download latest FW package from the web

    mlxfwmanager --download-default --download-os Linux_x64 --download-type self_extractor

adham-mellanox commented 6 years ago

Fixed in master_devel, will be merged in mstflint 4.9.0 soon