1.\" 2.\" Copyright (c) 2018, 2019 Mellanox Technologies 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd May 7, 2019 29.Dt mlx5tool 8 30.Os 31.Sh NAME 32.Nm mlx5tool 33.Nd Utility for managing Connect-X 4/5 Mellanox network adapters 34.Sh SYNOPSIS 35.Nm 36.Fl d Ar domain:bus:slot:func 37.Fl e 38.Nm 39.Fl d Ar domain:bus:slot:func 40.Fl rn 41.Nm 42.Fl d Ar domain:bus:slot:func 43.Fl o Ar file 44.Fl w 45.Nm 46.Fl d Ar domain:bus:slot:func 47.Fl f Ar file.mfa2 48.Nm 49.Fl d Ar domain:bus:slot:func 50.Fl z 51.Sh DESCRIPTION 52The 53.Nm 54utility is provided for management of the Connect-X 4 and 5 network adapters 55in the aspects not covered by the generic 56.Xr ifconfig 8 57command, mostly related to the PCIe attachment and internal card working. 58The utility executes commands on specific adapter, which is addressed using 59.Em device:bus:slot:function 60conventions of the PCIe buses. 61You can match adapters ethernet name and addresses using the 62.X pciconf 8 63utility. 64The address is passed as an argument of the 65.Fl d 66option, which must be specified for each invocation. 67.Pp 68When the driver detects the malfunctioning of the hardware, or by user 69request, it is possible to create 70.Em firmware dump , 71which contains debugging information about internal device state, for 72analysis of the failure by the Mellanox support team. 73.Pp 74The following commands are currently implemented: 75.Bl -tag -width indent 76.It Fl e 77Take the snapshot of the firmware registers state and store it in the 78kernel buffer. 79The buffer must be empty, in other words, no dumps should be written so 80far, or existing dump cleared with the 81.Fl r 82command for the specified device. 83.It Fl r 84Clear the stored firmware dump, preparing the kernel buffer for 85the next dump. 86.It Fl w 87Fetches the stored firmware dump and writes it into the file specified 88by the 89.Fl o 90option argument. 91.It Fl f 92Flashes the firmware image 93.Fa file.mfa2 94to the specified adapter. 95Image must be in MFA2 pack format and contain a component suitable 96for the adapter hardware. 97.Pp 98Typically, PCIe link-level reset is required to activate the 99newly flashed image, which can be performed by the system reboot 100or using the 101.Fl z 102option. 103.It Fl z 104Performs PCIe link-level reset on the specified device. 105.El 106.Sh FILES 107The 108.Pa /dev/mlx5ctl 109.Xr devfs 5 110node is used to pass commands to the driver. 111.Sh SEE ALSO 112.Xr mlx5en 4 , 113.Xr mlx5ib 4 , 114.Xr mlx5io 4 , 115.Xr ifconfig 8 116and 117.Xr pciconf 8 . 118