share/man/man4/mlx5en.4

   1 .\" Copyright (c) 2015 Mellanox Technologies
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd December 3, 2015
  28 .Dt mlx5en 4
  29 .Os
  30 .Sh NAME
  31 .Nm mlx5en
  32 .Nd "Mellanox ConnectX-4 and ConnectX-4 LX based 100Gb, 50Gb, 40Gb, 25Gb and 10Gb Ethernet adapter driver"
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "options COMPAT_LINUXKPI"
  39 .Cd "device mlx5"
  40 .Cd "device mlx5en"
  41 .Ed
  42 .Pp
  43 To load the driver as a module at run-time,
  44 run the following command as root:
  45 .Bd -literal -offset indent
  46 kldload mlx5en
  47 .Ed
  48 .Pp
  49 To load the driver as a
  50 module at boot time, place the following lines in
  51 .Xr loader.conf 5 :
  52 .Bd -literal -offset indent
  53 mlx5en_load="YES"
  54 .Ed
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 driver provides support for PCI Express Ethernet adapters based on
  59 ConnectX-4 and ConnectX-4 LX.
  60 The driver supports Jumbo Frames, Transmit/Receive checksum offload,
  61 TCP segmentation offload (TSO), Large Receive Offload (LRO),
  62 HW Large Receive Offload (HW LRO), VLAN tag insertion/extraction,
  63 VLAN checksum offload, VLAN TSO, and Receive Side Steering (RSS).
  64 .br
  65 The network interface is named mce.
  66 .br
  67 For further hardware information and questions related to hardware
  68 requirements, see
  69 .Pa http://www.mellanox.com/ .
  70 .Pp
  71 For more information on configuring this device, see
  72 .Xr ifconfig 8 .
  73 .Sh HARDWARE
  74 The
  75 .Nm
  76 driver supports 100Gb, 50Gb, 40Gb, 25Gb and 10Gb Ethernet adapters.
  77 ConnectX-4 supports:10/20/25/40/50/56/100Gb/s speeds.
  78 ConnectX-4 LX supports:10/25/40/50Gb/s speeds (and reduced power consumption) :
  79 .Pp
  80 .Bl -bullet -compact
  81 .It
  82 Mellanox MCX455A-ECAT
  83 .It
  84 Mellanox MCX456A-ECAT
  85 .It
  86 Mellanox MCX415A-CCAT
  87 .It
  88 Mellanox MCX416A-CCAT
  89 .It
  90 Mellanox MCX455A-FCAT
  91 .It
  92 Mellanox MCX456A-FCAT
  93 .It
  94 Mellanox MCX415A-BCAT
  95 .It
  96 Mellanox MCX416A-BCAT
  97 .It
  98 Mellanox MCX4131A-GCAT
  99 .It
 100 Mellanox MCX4131A-BCAT
 101 .It
 102 Mellanox MCX4121A-ACAT
 103 .It
 104 Mellanox MCX4111A-ACAT
 105 .It
 106 Mellanox MCX4121A-XCAT
 107 .It
 108 Mellanox MCX4111A-XCAT
 109 .El
 110 .Sh SUPPORT
 111 For general information and support,
 112 go to the Mellanox support website at:
 113 .Pa http://www.mellanox.com/ .
 114 .Pp
 115 If an issue is identified with this driver with a supported adapter,
 116 email all the specific information related to the issue to
 117 .Aq Mt freebsd-drivers@mellanox.com .
 118 .Sh SEE ALSO
 119 .Xr ifconfig 8
 120 .Sh HISTORY
 121 The
 122 .Nm
 123 device driver first appeared in
 124 .Fx 11.0 .
 125 .Sh AUTHORS
 126 .An -nosplit
 127 The
 128 .Nm
 129 driver was written by
 130 .An Mellanox Technologies <freebsd-drivers@mellanox.com> .