Nvidia MSTFLINT Documentation
Text of the manual
Exported on Apr/28/2022 11:57 AM
MSTFLINT Package -Firmware Burning and
Diagnostics Tools Documentation v4.20.0
Table of Contents
Overview ........................................................................................ 5
Intended Audience...................................................................................5
Document Revision History .........................................................................5
Release Notes................................................................................... 6
Release Notes Update History......................................................................6
General Information.................................................................................6
Package Tools.....................................................................................6
Dependencies.....................................................................................7
mstflint Supported Operating Systems and Platforms......................................8
Supported Flash Types......................................................................... 11
Supported Interface Cards (NICs)............................................................ 12
Supported Switch Systems Software ........................................................ 12
Changes and New Features....................................................................... 13
mstflint Bug Fixes in this Version................................................................ 14
mstflint Known Issues ............................................................................. 14
Introduction....................................................................................17
Supported Operating Systems.................................................................... 17
Access to Hardware Devices...................................................................... 17
Compilation and Installation ..................................................................... 18
Firmware Generation, Configuration, and Update Tools................................19
mstfwmanager – Firmware Update and Query Tool........................................... 19
mstfwmanager Synopsis....................................................................... 19
Querying the Device........................................................................... 20
Archived Images Content ..................................................................... 21
mstarchive – Binary Files Compression Tool.................................................... 22
mstarchive Synopsis ........................................................................... 22
mstconfig – Changing Device Configuration Tool .............................................. 23
Tool Requirements ............................................................................. 23
mstconfig Synopsis............................................................................. 23
Examples of mstconfig Usage ................................................................ 24
Using mstconfig ................................................................................ 26
mstconfig Commands.......................................................................... 28
mstconfig Supported Configurations and Parameters .................................... 30
mstflint – Firmware Burning Tool ................................................................ 31
Switches Options............................................................................... 31
Command Parameters......................................................................... 34
mstflint: Burning a Firmware Image ........................................................ 35
mstflint: Managing an Expansion ROM Image.............................................. 41
mstflint: Performing Checksum Calculation on Image/Device.......................... 41
mstflint: Querying the Firmware Image.................................................... 42
mstflint: Setting GUIDs and MACs ........................................................... 43
mstflint: Verifying the Firmware Image .................................................... 47
mstflint: Setting the VSD ..................................................................... 48
mstflint: Disabling/Enabling Access to the Hardware.................................... 49
mstflint: Flash Operations.................................................................... 50
mstflint: Comparing the Binary Image...................................................... 52
mstflint: Firmware Timestamping for Multi-Host Environment ......................... 52
mstflint Limitations ........................................................................... 54
mstflint: Secure Host.......................................................................... 54
mstflint: Secure Firmware Update .......................................................... 56
mstfwreset – Loading Firmware on 5th Generation Devices Tool........................... 60
Tool Requirements ............................................................................. 60
mstfwreset Synopsis........................................................................... 60
Reset Levels and Types........................................................................ 61
mstfwreset for Multi-Host NICs .............................................................. 61
mstfwreset for Socket-Direct NICs .......................................................... 62
mstfwreset for SmartNICs .................................................................... 62
Examples of mstfwreset Usage .............................................................. 62
mstfwreset Limitations ....................................................................... 63
mstcongestion – Tool for Setting Congestion Mode and Action.............................. 63
Tool Requirements ............................................................................. 64
mstcongestion Synopsis ....................................................................... 64
mstprivhost - NIC Configuration by the Host Restriction Tool............................... 64
mstprivhost Synopsis .......................................................................... 64
Disabling/Enabling Access to the Hardware ................................................... 65
4th Generation Devices ....................................................................... 65
5th Generation Devices ....................................................................... 66
Debug Utilities.................................................................................68
mstfwtrace Utility ................................................................................. 68
mstfwtrace Usage.............................................................................. 68
mstregdump Utility ................................................................................ 69
mstdregump Usage ............................................................................ 69
mstreg Utility....................................................................................... 70
mstreg Usage ................................................................................... 70
mstlink Utility ...................................................................................... 72
mstlink Usage................................................................................... 72
Margin Scan Tool ............................................................................... 78
Rx-to-Tx Loopback Mode Activation......................................................... 79
Tool Usage with NIC vs. Switch (-p Flag) ................................................... 79
mstresourcedump Utility ......................................................................... 80
mstresourcedump Usage...................................................................... 81
mstresourceparse Utility.......................................................................... 83
mstresourceparse Usage ...................................................................... 83
Troubleshooting ...............................................................................86
General Related Issues ............................................................................ 86
mstconfig Related Issues.......................................................................... 86
Installation Related Issues........................................................................ 87
Firmware Burning Related Issues ................................................................ 87
Secure Firmware Related Issues ................................................................. 89
Appendixes.....................................................................................91
mstflint - Updating Firmware Using ethtool/devlink and .mfa2 File ...................... 91
mstflint User Manual Revision History .....................................................93
Release Notes Revision History .............................................................96
mstflint Release Notes Change Log History .................................................... 96
mstflint Bug Fixes History .......................................................................114
The NVIDIA® Firmware Tools (mstflint) package is a set of firmware management and debug tools for
NVIDIA devices. The document describes mstflint features, tools content and configuration.
The documentation here relates to:
Release Notes
User Manual
Intended Audience
This manual is intended for system administrators responsible for managing and debugging
firmware for NVIDIA devices.
Document Revision History
A list of the changes made to the user manual are provided in Document Revision History.