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