The fwtrace utility extracts and prints trace messages generated by the firmware running on 5th generation (Group II) devices iRISCs.
These trace messages inform developers of software drivers about internal status, events, critical errors, etc. Trace messages generated by iRISCs are stored in the trace buffer. The trace buffer is located in host memory. The tool also supports mem free mode where it uses a device internal small buffer.
By default, the firmware does not print trace messages. Please contact your FAE for more details on how to enable firmware tracing.
When using secure firmware, the user needs to validate that the value "1" is set to /sys/kernel/debug/tracing/events/mlx5/fw_tracer/enable.
Memory mode on 5th generation (Group II) devices is supported only by PCI mst devices.
For the tool to properly work with Inband devices, both the MFT and the Firmware must be updated to the latest (MFT v4.18.0 & firmware vXX.32.1xxx).
If ConnectX-4 adapter card is used as an Inband device, for the tool to work properly, you need to use MFT 4.17.0.
- Start the mst driver (mst start or mst restart)
Enter the following command:
|-h|--help||Print this help message and exit|
|-d|--device||mst device name|
|-f|--fw_strings||Fw strings db file containing the FW strings|
Tracer mode [FIFO | MEM]
|--real_ts||Print real timestamps in [hh:mm:ss:nsec] format|
|-i|--irisc||iRISC name (See below for full list of irisc names)|
Allow the user to specify which tile events he would like to see.
# "1.all" will enable risc1 in all tiles.
# "1" will be treated like "1.all"
# "all" will be treated like all.all
# "all.1" will enable all iriscs in tile 1
# .1 is invalid input.
|-a|--apu||If enabled, tool will show APU events.|
|--include_phy_uc||If enabled, tool will also show phy_uc events related to the enabled riscs (main / tiles)|
|--keep_cfg||If enabled, the FWtrace will not delete the temporary cfg file (if one was created during the current run)|
|-s|--stream||Run in streaming mode|
|-c|--cfg||HW tracer events cfg file|
|-n|--snapshot||Take events snapshot - this assumes previous FW configurations|
|-S|--buf_size||HW tracer MEM buffer size in [MB]|
|--dump||Dump file name|
|-m|--mask||Trace class mask, use "+" to enable multiple classes or use integer format, e.g: -m class1+class2+... or 0xff00ff00|
|v|--version||Print tool's version and exit|
|--gvmi||Global virtual machine interface|
|--ignore_old_events||Ignore collecting old events|
|--mem_access||Memory access method: OB_GW, VMEM, UDRIVER|
|--keep_running||Keep the hardware tracer unit running after exit|
|--config_only||Configure tracer and exit|
Device Specific Info:
To view device specific information, run
"fwtrace -d <mst_dev> -h".