MFT user manual - mellanox.com

1 Mellanox Firmware Tools (MFT) User ManualRev ver. Technologies350 Oakmead Parkway Suite 100 Sunnyvale , CA : (408) 970-3400 Fax: (408 ) 970-3403 Copyright 2018. Mellanox Technologies Ltd . All Rights Reserved .Mellanox , Mellanox logo, Accelio , BridgeX , CloudX logo, CompustorX , Connect -IB , ConnectX , CoolBox , CORE-Direct , EZchip , EZchip logo, EZappliance , EZdesign , EZdriver , EZsystem , GPUD irect , InfiniHost , InfiniBridge , InfiniScale , Kotura , Kotura logo, Mellanox CloudRack , Mellanox CloudXMellanox , Mellanox Federal Systems , Mellanox HostDirect , Mellanox Multi-Host , Mellanox Open Ethernet , Mellanox OpenCloud , Mellanox OpenCloud Logo , Mellanox PeerDirect , Mellanox ScalableHPC , Mellanox StorageX , Mellanox TuneX , Mellanox Connect Accelerate Outperform logo , Mellanox Virtual Modular Switch , MetroDX , MetroX , MLNX-OS , NP-1c , NP-2 , NP-3 , NPS , Open Ethernet logo , PhyX , PlatformX , PSIPHY , SiPhy , StoreX , SwitchX , Tilera , Tilera logo, TestX , TuneX.

2 The Generation of Open Ethernet logo , UFM , Unbreakable Link , Virtual Protocol Interconnect , Voltaire and Voltaire logo are registered trademarks of Mellanox Technologies , other trademarks are property of their respective owners .For the most updated list of Mellanox trademarks, visit /page/trademarksNOTE:THIS HARDWARE, SOFTWARE OR TEST SUITE PRODUCT ( PRODUCT (S) ) AND ITS RELATED DOCUMENTATION ARE PROVIDED BY MELLANOX TECHNOLOGIES AS-IS WITH ALL FAULTS OF ANY KIND AND SOLELY FOR THE PURPOSE OF AIDING THE CUSTOMER IN TESTING APPLICATIONS THAT USE THE PRODUCTS IN DESIGNATED SOLUTIONS. THE CUSTOMER'S MANUFACTURING TEST ENVIRONMENT HAS NOT MET THE STANDARDS SET BY MELLANOX TECHNOLOGIES TO FULLY QUALIFY THE PRODUCT(S) AND/OR THE SYSTEM USING IT. THEREFORE, MELLANOX TECHNOLOGIES CANNOT AND DOES NOT GUARANTEE OR WARRANT THAT THE PRODUCTS WILL OPERATE WITH THE HIGHEST QUALITY.

3 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL MELLANOX BE LIABLE TO CUSTOMER OR ANY THIRD PARTIES FOR ANY DIRECT, INDIRECT, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES OF ANY KIND (INCLUDING, BUT NOT LIMITED TO, PAYMENT FOR PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY FROM THE USE OF THE PRODUCT (S) AND RELATED DOCUMENTATION EVEN IF ADVISED OF THE POSSIBILITY OF SUCH #: MLNX-15-xxxxx2 Mellanox TechnologiesRev TechnologiesTable of Content Table of Content .. 1 List of Tables.

4 5 List of Figures .. 6 Chapter 1 Introduction .. Supported Operating Systems .. MFT Access to Hardware Devices .. MFT Installation .. 24 Chapter 2 Firmware Generation, Configuration, and Update Tools .. Mellanox Software Tools (mst) Service .. Linux .. Running mst in an Environment without a kernel .. Windows .. FreeBSD .. VMware ESXi .. mlxfwmanager - Firmware Update and Query Tool .. mlxfwmanager Synopsis .. Querying the Device .. Updating the Device .. Updating the Device Online .. Update Package for Mellanox Firmware .. Update Package for Mellanox Firmware Generation Flow .. Updating Firmware Using an UPMF .. mlxconfig - Changing Device Configuration Tool .. Tool Requirements .. mlxconfig Synopsis .. Examples of mlxconfig Usage .. Using mlxconifg with PCI Device in Bus Device Function (BDF) Format.

5 Using mlxconfig to Set VPI Parameters .. Using mlxconfig to Set SR-IOV Parameters .. Using mlxconfig to Set preboot Settings .. mlxconfig Raw Configuration Files.. mlxconfig Backup Command .. Generating an XML Template for the Configurations .. mlxconfig xml2raw Command .. mlxconfig xml2bin Command .. mlxconfig create_conf Command .. mlxconfig apply Command .. 57 Rev Supported Configurations and their Parameters.. flint Firmware Burning Tool .. flint Synopsis .. Burning a Firmware Image .. Querying the Firmware Image .. Verifying the Firmware Image .. Performing Checksum Calculation on Image/Device .. Managing an Expansion ROM Image .. Setting GUIDs and MACs .. Setting the VSD .. Disabling/Enabling Access to the Hardware .. Reading a Word from Flash .. Writing a dword to Flash .. Writing a dword to Flash Without Sector Erase.

6 Erasing a Sector .. Querying Flash Parameters .. Firmware Time-stamping for Multi-host Environment .. Flint/mlxburn Limitations .. Secure Host .. Secure Firmware Update .. mlxburn - Firmware Image Generator and Burner .. Generating and Burning Firmware .. Customizing Firmware .. mlxburn Synopsis .. Examples of mlxburn Usage .. Exit Return Values .. mlxfwreset - Loading Firmware on 5th Generation Devices Tool .. Tool Requirements .. mlxfwreset Synopsis .. Reset Levels .. mlxfwreset for Multi-Host NICs .. Examples of mlxfwreset Usage .. mlxfwreset Limitations .. mlxphyburn Burning Tool for Externally Managed PHY .. Tool Requirements .. mlxphyburn Synopsis .. Examples of mlxphyburn Usage .. mlx_fpga - Burning and Debugging Tool for Mellanox Devices with FPGA Tool Requirements.

7 Mlx_fpga Synopsis .. Examples of mlx_fpga Usage .. cpldupdate - Tool for Programming On-Board CPLDs on Mellanox Devices 117 Rev Tool Requirements .. cpldupdate Synopsis .. Burn Example.. 118 Chapter 3 Debug Utilities .. fwtrace Utility .. fwtrace Usage .. itrace Utility.. itrace Usage .. mstdump Utility .. mstdump Usage .. mlxi2c Utility .. mlxi2c Usage .. i2c Utility .. i2c Usage (Advance Users) .. Exit Return Values .. mget_temp Utility .. mget_temp Usage .. mlxtrace Utility .. mlxtrace Usage .. mlxdump Utility .. mlxdump Usage.. mlxmcg Utility .. mlxmcg Usage .. pckt_drop Utility .. pckt_drop Usage.. mlxuptime Utility .. mlxuptime Usage .. wqdump Utility .. wqdump Usage .. mlxmdio Utility .. mlxmdio Usage .. mlxreg Utility.. mlxreg Usage.

8 Mlxlink Utility .. mlxlink Usage .. Tool Usage with NIC vs. Switch (-p Flag) .. 143 Chapter 4 Cables Utilities .. Cables Discovery .. How to Discover the Cables .. Representing the Cables in mst Status .. 144 Rev Working with Cables.. mlxcables - Mellanox Cables Tool .. mlxcables Synopsis .. MTUSB Cable Board .. Cable Firmware Upgrade with In Service Firmware Update (ISFU) .. 154 Chapter 5 Troubleshooting .. General Related Issues.. mlxconfig Related Issues .. Installation Related Issues .. Firmware Burning Related Issues .. Secure Firmware Related Issues .. 161 Appendix A Assigning PSID .. PSID Field Structure .. Assigning PSID and Integrat Flow .. 163 Appendix B Remote Access to Mellanox Devices .. Burning a Switch In-band Device Using mlxburn .. In-Band Access to Multiple IB Subnets.

9 MTUSB-1 USB to I2C Adapter .. Remote Access to Device by Sockets .. Accessing Remote InfiniBand Device by Direct Route MADs .. 171 Appendix C Booting HCA Device in Livefish Mode .. Booting Card in Livefish Mode .. Booting Card in Normal Mode .. Common Locations of Flash Present Pins .. 173 Appendix D Burning a New Device.. Connect-IB Adapter Card .. ConnectX -4/ConnectX -5 Adapter Cards Family .. Switch-IB Switch System .. Spectrum or Switch-IB 2 Switch Systems .. 180 Appendix E Generating Firmware Secure and NV LifeCycle Configurations Files Create Forbidden Versions Binary File .. Create Tokens for Secure Firmware and NV LifeCycle .. 183 Rev TechnologiesList of TablesTable 1:Revision History Table .. 7 Table 2:Common Abbreviations and Acronyms .. 19 Table 3:Reference Documents and Downloads.

10 20 Table 4:Supported Mellanox Devices .. 22 Table 5:MFT Installation .. 24 Table 6:mst start Supported OPCODES .. 28 Table 7:Supported Configurations and their Parameters .. 58 Table 8:mlx_fpga Tool Registers .. 116 Table 9:General Related Issues .. 156 Table 10:mlxconfig Related Issues .. 157 Table 11:Installation Related Issues.. 157 Table 12:Firmware Burning Related Issues .. 158 Table 13:Secure Firmware Related Issues .. 161 Table 14:PSID format .. 163 Table 15:MTUSB-1 Package Contents .. 168 Rev TechnologiesList of FiguresFigure 1:Mellanox Firmware Tools A Scheme of Operation .. 21 Figure 2:UPMF Package Generation Flow .. 44 Figure 3:FW Generation and Burning .. 103 Figure 4:MTUSB-1 Device ..167 Rev TechnologiesDocument Revision HistoryTable 1: Revision History Table (Sheet 1 of 12) 1, 2018 Added the following sections: Section , For 5th Generation Devices , on page 93 Updated the following sections: Section , Querying the Device Configuration , on page 48 Section , mlxconfig create_conf Command , on page 57 Section , Signing Binary Image Files , on page 100 Section , mget_temp Usage , on page 126 Section , mlxlink Usage , on page 141 Section 7, Supported Configurations and their Parame-ters , on page 58: Added the following parameters: SW_RECOVERY_ON_ERRORS RESET_WITH_HOST_ON_ERRORS IBM_TUNNELED_ATOMIC_EN EXP_ROM_PXE_ENABLE EXP_ROM_UEFI_x86_ENABLE EXP_ROM_UEFI_ARM_ENABLE HOST_CHAINING_MODE HOST_CHAINING_DESCRIPTORS HOST_CHAINING_TOTAL_BUFFER_SIZE Section , Using Secure Host , on page 30, 2017 Added the following sections.