User Manual Revision History

4.26.1

December 14, 2023

No changes to the User Manual.

4.26.0

November 6, 2023

Updated:

• mlxdpa – DPA Applications Sign Tool

• mlxconfig – Changing Device Configuration Tool

4.25.1

October 22, 2023

Added:

• Advance Options to "Generating an XML Template for the Configurations" under mlxconfig Commands.

4.25.0

August 10, 2023

Updated:

• Cable Burn Command Running CMIS Firmware Upgrade Flow for Supported Cables under Burning a Firmware Image.

• mlxdpa – DPA Applications Sign Tool

• mlxfwreset – Loading Firmware on 5th Generation Devices Tool

• fwtrace Utility

• mlxtrace Utility

• resourcedump Utility

• resourceparse Utility

• mst Synopsis - Windows under Windows.

• mst Synopsis - VMware under VMware ESXi.

• mst Synopsis - FreeBSD under FreeBSD.

• mst Synopsis - Linux under Linux.

Added:

• mlxcableimgen - Cable Firmware Image Wrapper Generation Tool under Firmware Generation, Configuration, and Update Tools. 

4.24.0

May 4, 2023

Updated:

• mlxprivhost - NIC Configuration by the Host Restriction Tool (Zero Trust Mode)

• Examples of mlxfwreset Usage

• mlxtokengenerator Synopsis

• Using mlxconfig to Split a Port in a Remotely Managed Switch

• flint – Firmware Burning Tool

• mlxlink Utility

• mlxfwstress Utility

• mstdump Utility

Added:

• Burning/Querying a Component under flint – Firmware Burning Tool

4.23.0

January 31, 2023

Updated:

• resourcedump Utility

• resourceparse

• fwtrace Utility

• mlxtrace Utility

• Burning a Firmware Image

• Verifying the Firmware Image

Added:

• mlxdpa – DPA Applications Sign Tool

• Added "MFTshell" under User Manual.

4.22.0

October 31, 2022

In the mlxlink Utility chapter:

• Updated:

  • Margin Scan Tool

  • RX Error Injection

  • Module PRBS Test Mode

  • Tool Usage with NIC vs. Switch (-p Flag)

• Added:

  • PCIE Error Injection

In the mlxfwreset – Loading Firmware on 5th Generation Devices Tool chapter added mlxfwreset for Switch Devices.

Added a note in resourcedump Utility.

4.21.0

July 31, 2022

Updated mlxfwreset – Loading Firmware on 5th Generation Devices Tool, added "mlxfwreset after Changing Configurations using mlxconfig".

Updated Burning a Firmware Image, added "Querying Vendor Specific Firmware Information from a NVIDIA AOC / Transceiver".

Updated the "-l |--loopback <loopback> " description in mlxlink Utility.

Added "–mem_access" flag to fwtrace Utility

Added the "–noddr" and "–mmap" flags to itrace Utility

Removed the following flags: vpd_prog_rw<rw-keywords-file> &-vpd_set_keyword <keywordassignment> from mlxburn – Firmware Image Generator and Burner

mlxtokengenerator - Token Creation Tool added new section.

4.20.0

April 30, 2022

• Updated mlxlink commands, added cable operations.

• Updated mlxprivhost, added Embedded Arm CPU options.

• Updated resourcedump Utility, added the "–mem" key.

• Updated Create Tokens for Secure Firmware and NV LifeCycle.

4.18.1

January 16, 2022

• Added section Tool Usage on NVIDIA Quantum-2 NDR Switch Systems

4.18.0

November 30, 2021

• Updated section mlxlink Utility:

  • Added "--tx_prbs <tx_prbs_mode>" & "--rx_prbs <rx_prbs_mode>" flags

  • Added "--amber_collect" flag

4.17.0

June 30, 2021

• Updated section Querying the Firmware Image, added Secure-boot attributes.

• Updated section mlxprivhost.

• Updated section Burning a Firmware Image, added the " --activate_delay_sec <timeout in seconds>" flag.

• Updated section mlxlink, added "--fom_measurement <eye>" flag.

4.16.3

March 31, 2021

• Updated section mlxfwreset

• Updated section mlxlink: added FEC errors' histogram

4.16.2

March 01, 2021

• Added section RX Error Injection

• Added section Hardware Security Module (HSM)

• Added section Secure Boot

• Updated section mlxconfig create_conf Command

• Updated section flint – Firmware Burning Tool: added the --openssl_engine <engine name>, --openssl_key_id <key> and rsa_sign flags

• Updated section mlxconfig: added -eng|--openssl_engine and -k|–open_ssl_key_id flags

4.16.1

February 08, 2021

No changes to the User Manual.

4.16.0

January 04, 2020

• Added section stedump Utility

• Added section Cable Firmware Update (In-Field-Firmware-Update)

• Updated section mlxconfig: added get_raw flag

• Updated section mlxprivhost: added the q,query flags

• Updated section mlxlink: added the --invert_tx_polarity & --invert_rx_polarity flags

• Updated section Margin Scan Tool

4.15.1

September 15, 2020

• Updated section mlxlink: added Margin Scan for PCIe Link.

• Updated mlxmdio Utility

• Uopated flint – Firmware Burning Tool

4.15.0

July 31, 2020

• Updated the following sections:

  • mlxlink

  • mlxfwreset

  • mlxcables: Removed the following flags: -u|--update, -i|--image-file <FileName>, f|–force, --yes, --no

4.14.4

May 31, 2020

• No changes to the User Manual.

4.14.2

April 30, 2020

• Added section resourceparse Utility

• Updated section mlxlink Utility

4.14.0

February 28, 2020

• Added section Burning the MFA2 Images

• Updated section MFT Supported Configurations and Parameters, added BOOT_INTERRUPT_DIS

4.13.3

December 12, 2019

• Added a new registry key to

  mlxreg Utility

• Added the following section:

  • Comparing the Binary Image

4.13.0

September 26, 2019

• Added the "DYNAMIC_VF_MSIX_TABLE" parameter, see MFT Supported Configurations and Parameters

• Updated the following sections:

  • .mlxlink Utility v4.18.1. Added a new subsection Tool Usage on Quantum HDR Switch Systems with Split Ports

  • mlxfwreset – Loading Firmware on 5th Generation Devices Tool

4.12.0

April 30, 2019

• Updated the following sections:

  • mlxfwmanager – Firmware Update and Query Tool: Added the following options:

    • "--download-type Type" and "--ssl-certificate Certificate"

  • flint – Firmware Burning Tool: Added the following options:

    • "-qq", "-low_cpu" and "-flashed_version"

  • mlxburn – Firmware Image Generator and Burner: Added the following options:

    • "[-gb_bin_file <gb_bin_file>]"

    • "-striped_image"

    • "-vsd <string>"

    • Updated the "-dev_type <mellanox-device-number>" option description

    • Updated the "Additional mlxburn Options"

  • mlxlink Utility: Added the following options:

    • "--depth <depth>", "--pcie_index <pcie_index>", and "--node <node>"

  • fwtrace Utility: Added the following options:

  • • "--gvmi" and "--ignore_old_events"

  • Using mlxconfig to Split a Port in a Remotely Managed Switch

4.11.0

March 2019

Converted to online html format; some reorganization.