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