Nvidia MSTFLINT User Manual

92
An example of how to run the query command:
# mstresourcedump query --device 04:00.0
__________________________________________________________________

Segment Type - 0x1300 (FULL_EQC)
Dump Params Applicability Special Values
-------------------------------- -------------- --------------
index1 (EQN) Mandatory N/A
num-of-obj1 N/A N/A
index2 (N/A) N/A N/A
num-of-obj2 N/A N/A
__________________________________________________________________
__________________________________________________________________

Segment Type - 0x1000 (FULL_QPC)
Dump Params Applicability Special Values
-------------------------------- -------------- --------------
index1 (QPN) Mandatory N/A
num-of-obj1 N/A N/A
index2 (N/A) N/A N/A
num-of-obj2 N/A N/A
…
…
…
mstresourcedump dump Usage
mstresourcedump dump [-h] --device DEVICE --segment SEGMENT [--virtual-hca-id
VIRTUAL_HCA_ID] [--index1 INDEX1] [--index2 INDEX2] [--num-of-obj1 NUM_OF_OBJ1]
[--num-of-obj2 NUM_OF_OBJ2] [--depth DEPTH] [--bin BIN]
where
-h, --help Show help message and exit
--virtual-hca-id The virtual HCA (host channel adapter, NIC) ID
--index1 The first context index to dump (if supported for this segment)
--index2 The second context index to dump (if supported for this
segment)
--num-of-obj1 The number of objects to be dumped (if supported for this
segment). accepts: ["all", "active", number, depends on the
capabilities]
--num-of-obj2 The number of objects to be dumped (if supported for this
segment). accepts: ["all", "active", number, depends on the
capabilities]
--depth The depth of walking through reference segments. 0 stands for
flat, 1 allows crawling of a single layer down the struct, etc.
"inf" for all
--bin The output to a binary file that replaces the default print in
hexadecimal, a readable format

Nvidia MSTFLINT Specifications

General

Brand	Nvidia
Model	MSTFLINT
Category	Tools
Language	English

Summary

Release Notes

Package Tools

Lists available tools in the package with descriptions.

mstflint Supported Operating Systems and Platforms

Details supported operating systems and platforms for mstflint.

Supported Flash Types

Lists supported flash types for mstflint.

Supported Mellanox ICs

Lists supported Mellanox ICs by IC Group and IC Device.

Supported Switch Systems Software

Lists supported Mellanox Switch Systems Software and their versions.

mstflint Bug Fixes in this Version

Lists bugs fixed in the current version of mstflint.

mstflint Known Issues

Lists known issues and limitations for the current mstflint release.

Introduction

Supported Operating Systems

Refers to release notes for supported platforms and kernels.

Access to Hardware Devices

Lists supported Mellanox devices, tools, and access methods.

Compilation and Installation

Provides instructions for compiling and installing mstflint.

Firmware Generation, Configuration, and Update Tools

mstfwmanager – Firmware Update and Query Tool

Utility for updating and querying Mellanox device firmware.

mstarchive – Binary Files Compression Tool

Tool to create MFA2 files containing binary firmware for adapter cards.

mstconfig – Changing Device Configuration Tool

Tool to change device configurations without reburning firmware.

mstflint – Firmware Burning Tool

Utility to burn firmware images to adapter or switch device flash.

mstfwreset – Loading Firmware on 5th Generation Devices Tool

Tool to load updated firmware on NICs without rebooting.

mstcongestion – Tool for Setting Congestion Mode and Action

Tool to configure device behavior for excessive ingress traffic.

mstprivhost - NIC Configuration by the Host Restriction Tool

Restricts hosts from configuring the NIC, granting privilege to the Arm side.

Debug Utilities

mstfwtrace Utility

Extracts and prints trace messages generated by firmware on 5th generation devices.

mstregdump Utility

Dumps device internal configuration registers for troubleshooting.

mstreg Utility

Obtains information about access registers and allows data access.

mstlink Utility

Checks and debugs link status and issues related to links and cables.

mstresourcedump Utility

Extracts and prints data segments generated by firmware for debug.

Troubleshooting

General Related Issues

Covers general issues related to adapter identification and boot problems.

mstconfig Related Issues

Addresses issues with mstconfig, especially concerning SRIOV configuration.

Installation Related Issues

Discusses problems encountered during tool package installation.

Firmware Burning Related Issues

Details issues encountered during firmware update and burning processes.

Secure Firmware Related Issues

Outlines problems and limitations when using secure firmware features.

Appendixes

mstflint - Updating Firmware Using ethtool/devlink and .mfa2 File

Guide to updating firmware using ethtool/devlink with .mfa2 files.

mstflint User Manual Revision History

Provides a history of changes made to the mstflint user manual.

mstflint Release Notes Change Log History

Lists changes and bug fixes across different mstflint versions.