share/man/man4/mlx5en.4

   1 .\" Copyright (c) 2015 Mellanox Technologies
   2 .\" Copyright (c) 2021 NVIDIA corporation & affiliates
   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 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 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 July 20, 2021
  29 .Dt MLX5EN 4
  30 .Os
  31 .Sh NAME
  32 .Nm mlx5en
  33 .Nd "NVIDIA Mellanox ConnectX-4/5/6 [Dx/Ex/Lx] based 200Gb, 100Gb, 50Gb, 40Gb, 25Gb and 10Gb ethernet adapter driver"
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "options COMPAT_LINUXKPI"
  40 .Cd "options RATELIMIT"
  41 .Cd "options KERN_TLS"
  42 .Cd "device xz"
  43 .Cd "device mlxfw"
  44 .Cd "device firmware"
  45 .Cd "device mlx5"
  46 .Cd "device mlx5en"
  47 .Ed
  48 .Pp
  49 To load the driver as a module at run-time,
  50 run the following command as root:
  51 .Bd -literal -offset indent
  52 kldload mlx5en
  53 .Ed
  54 .Pp
  55 To load the driver as a
  56 module at boot time, place the following lines in
  57 .Xr loader.conf 5 :
  58 .Bd -literal -offset indent
  59 mlx5en_load="YES"
  60 .Ed
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 driver provides support for PCI Express Ethernet adapters based on
  65 ConnectX-4/5/6 [Dx, Ex and Lx variants].
  66 The driver supports Jumbo Frames, Transmit and Receive checksum offload,
  67 TCP segmentation offload (TSO), Large Receive Offload (LRO),
  68 HW Large Receive Offload (HW LRO), VLAN tag insertion and extraction,
  69 VLAN checksum offload, VLAN TSO, hardware rate limiting (TXRTLMT),
  70 stateless VxLAN hardware offload for receive and transmit,
  71 HW TLS offload for transmit, Receive Side Steering (RSS) and
  72 .Xr NUMA 4
  73 awareness.
  74 .Pp
  75 The network interface name is
  76 .Dv mce<N>
  77 which corresponds to a PCI function,
  78 .Dv mlx_core<N> ,
  79 where
  80 .Dv <N>
  81 is a number starting at zero.
  82 There is at most one network interface per PCI function.
  83 .Pp
  84 For further information and questions related to hardware
  85 requirements, see
  86 .Pa https://www.mellanox.com .
  87 .Sh HARDWARE
  88 The
  89 .Nm
  90 driver supports 200Gb, 100Gb, 50Gb, 40Gb, 25Gb and 10Gb ethernet adapters.
  91 .Bl -bullet -compact
  92 .Pp
  93 .It
  94 ConnectX-6 supports 10/20/25/40/50/56/100Gb/200Gb/s speeds.
  95 .It
  96 ConnectX-5 supports 10/20/25/40/50/56/100Gb/s speeds.
  97 .It
  98 ConnectX-4 supports 10/20/25/40/50/56/100Gb/s speeds.
  99 .It
 100 ConnectX-4 LX supports 10/25/40/50Gb/s speeds and reduced power consumption.
 101 .El
 102 .Sh CONFIGURATION
 103 The
 104 .Nm
 105 network interface is configured using
 106 .Xr ifconfig 8
 107 and the
 108 .Xr sysctl 8
 109 tree at
 110 .Dv dev.mce.<N> .
 111 All configurable entries are also tunables, and can be put directly into the
 112 .Xr loader.conf 5
 113 for persistent configuration.
 114 .Sh SUPPORT
 115 For general information and support,
 116 go to the NVIDIA Mellanox networking support website at:
 117 .Pa https://www.mellanox.com .
 118 .Pp
 119 If an issue is identified with this driver using a supported adapter,
 120 e-mail all the specific information related to the issue to
 121 .Aq Mt nbu-freebsd-drivers@nvidia.com .
 122 .Sh SEE ALSO
 123 .Xr ifconfig 8
 124 .Sh HISTORY
 125 The
 126 .Nm
 127 device driver first appeared in
 128 .Fx 11.0 .
 129 .Sh AUTHORS
 130 .An -nosplit
 131 The
 132 .Nm
 133 driver was written by
 134 .An NVIDIA Mellanox networking <nbu-freebsd-drivers@nvidia.com> .