Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
mlx5tool(8)		FreeBSD	System Manager's Manual		   mlx5tool(8)

NAME
     mlx5tool -- Utility for managing Connect-X	4/5 Mellanox network adapters

SYNOPSIS
     mlx5tool -d domain:bus:slot:func -e
     mlx5tool -d domain:bus:slot:func -r
     mlx5tool -d domain:bus:slot:func -o file -w

DESCRIPTION
     The mlx5tool utility is provided for management of	the Connect-X 4	and 5
     network adapters in the aspects not covered by the	generic	ifconfig(8)
     command, mostly related to	the PCIe attachment and	internal card working.
     The utility executes commands on specific adapter,	which is addressed
     using device:bus:slot:function conventions	of the PCIe buses.  You	can
     match adapters ethernet name and addresses	using the utility.  The
     address is	passed as an argument of the -d	option,	which must be speci-
     fied for each invocation.

     When the driver detects the malfunctioning	of the hardware, or by user
     request, it is possible to	create firmware	dump, which contains debugging
     information about internal	device state, for analysis of the failure by
     the Mellanox support team.

     The following commands are	currently implemented:

     -e	     Take the snapshot of the firmware registers state and store it in
	     the kernel	buffer.	 The buffer must be empty, in other words, no
	     dumps should be written so	far, or	existing dump cleared with the
	     -r	command	for the	specified device.

     -r	     Clear the stored firmware dump, preparing the kernel buffer for
	     the next dump.

     -w	     Fetche the	stored firmware	dump and writes	it into	the file spec-
	     ified by the -o option argument.

FILES
     The /dev/mlx5ctl devfs(5) node is used to pass commands to	the driver.

SEE ALSO
     mlx5en(4),	mlx5ib(4), mlx5io(4), ifconfig(8) and pciconf(8).

FreeBSD	Ports 11.2		 March 8, 2018		    FreeBSD Ports 11.2

NAME | SYNOPSIS | DESCRIPTION | FILES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=mlx5tool&sektion=8&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help