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/6 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 e 41.Nm 42.Fl d Ar domain:bus:slot:func 43.Fl f Ar file.mfa2 44.Nm 45.Fl d Ar domain:bus:slot:func 46.Fl o Ar file 47.Fl w 48.Nm 49.Fl d Ar domain:bus:slot:func 50.Fl r 51.Nm 52.Fl d Ar domain:bus:slot:func 53.Fl z 54.Sh DESCRIPTION 55The 56.Nm 57utility is provided for management of the Connect-X4, 5 and 6 network adapters 58in the aspects not covered by the generic 59.Xr ifconfig 8 60command, mostly related to the PCIe attachment and internal card working. 61The utility executes commands on specific adapter, which is addressed using 62.Em device:bus:slot:function 63conventions of the PCIe buses. 64You can match adapters ethernet name and addresses using the 65.X pciconf 8 66utility. 67The address is passed as an argument of the 68.Fl d 69option, which must be specified for each invocation. 70.Pp 71When the driver detects the malfunctioning of the hardware, or by user 72request, it is possible to create 73.Em firmware dump , 74which contains debugging information about internal device state, for 75analysis of the failure by the Mellanox support team. 76.Pp 77The following commands are currently implemented: 78.Bl -tag -width indent 79.It Fl E 80Print EEPROM information 81.It Fl e 82Take the snapshot of the firmware registers state and store it in the 83kernel buffer. 84The buffer must be empty, in other words, no dumps should be written so 85far, or existing dump cleared with the 86.It Fl f 87Flashes the firmware image 88.Fa file.mfa2 89to the specified adapter. 90Image must be in MFA2 pack format and contain a component suitable 91for the adapter hardware. 92.Pp 93Typically, PCIe link-level reset is required to activate the 94newly flashed image, which can be performed by the system reboot 95or using the 96.Fl z 97option. 98.Fl r 99command for the specified device. 100.It Fl r 101Clear the stored firmware dump, preparing the kernel buffer for 102the next dump. 103.It Fl w 104Fetches the stored firmware dump and writes it into the file specified 105by the 106.Fl o 107option argument. 108.It Fl z 109Performs PCIe link-level reset on the specified device. 110.El 111.Sh FILES 112The 113.Pa /dev/mlx5ctl 114.Xr devfs 5 115node is used to pass commands to the driver. 116.Sh SEE ALSO 117.Xr mlx5en 4 , 118.Xr mlx5ib 4 , 119.Xr mlx5io 4 , 120.Xr ifconfig 8 121and 122.Xr pciconf 8 . 123