usr.sbin/mlx5tool/mlx5tool.8

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