image image image image image

On This Page

The resourcedump tool extracts and prints data segments generated by the firmware. It is supported in 5th generation NIC’s devices. The dump output is used by NVIDIA® for debug and troubleshooting.

mstresourcedump can be used only if Python 3.x is installed. Using lower versions will result in tool's failure.

It is important for the user to generate a bin file for debugging and troubleshooting cases when needed by NVIDIA.

If the firmware version used is not supported, the tool will generate the following error message:
“Error: Failed to fetch query data with exception: Failed to send Register RESOURCE DUMP with rc: 515. Exiting...”.

resourcedump Usage

resourcedump [-h] [-v] {dump,query} 

where

dump

Dump command

query

Query command

-h, --help

Show help message and exit

-v, --version

Shows tool version and exit

resourcedump query Usage 
resourcedump query [-h] [--virtual-hca-id VIRTUAL_HCA_ID] --device DEVICE

where

-h, --help

Show help message and exit

--virtual-hca-id The virtual HCA (host channel adapter, NIC) ID

-d, --device

The device name


An example of how to run the query command: 

# resourcedump query --device /dev/mst/mt4119_pciconf0
__________________________________________________________________

                 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      
…
…
…
resourcedump dump Usage
resourcedump 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

-d, --device

The device name

--segment

The segment to dump


Examples of how to:

  • Run the dump command: 

    # resourcedump dump --device /dev/mst/mt4119_pciconf0 --segment 0x1200 --index1 0x404 --depth 0
    Found 10 segments:                                                                                                                                                                     
    -------------------------------------------                                                                                                                                            
    Segment Type: 0xfffe                                                                                                                                                                   
    Segment Size: 16 Bytes                                                                                                                                                                 
    Segment Data:                                                                                                                                                                          
    0x0004FFFE 0x00000000 0x00000000 0x101A0111                                                                                                                                            
    -------------------------------------------                                                                                                                                            
    Segment Type: 0xfffa                                                                                                                                                                   
    Segment Size: 20 Bytes                                                                                                                                                                 
    Segment Data:                                                                                                                                                                          
    0x0005FFFA 0x12000000 0x00000404 0x00000000                                                                                                                                            
    0x00000000                                                                                                                                                                             
    -------------------------------------------
  • Run the Dump command and save it in bin file: 

    # resourcedump dump --device /dev/mst/mt4119_pciconf0 --segment 0x1200 --index1 0x404 --depth 0 -–bin segment_1200.bin
    write to file:  segment_1200.bin