share/man/man4/mlx4en.4

   1 .\" Copyright (c) 2016 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 September 30, 2016
  28 .Dt MLX4EN 4
  29 .Os
  30 .Sh NAME
  31 .Nm mlx4en
  32 .Nd "Mellanox ConnectX-3 10GbE/40GbE network 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 mlx4"
  40 .Cd "device mlx4en"
  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 mlx4en
  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 mlx4en_load="YES"
  54 .Ed
  55 .Sh DESCRIPTION
  56 Mellanox ConnectX adapter cards with Virtual Protocol Interconnect
  57 (VPI) provide the highest performing and most flexible interconnect
  58 solution for Enterprise Data Centers, High-Performance Computing, and
  59 Embedded environments.
  60 Clustered data bases, parallelized applications, transactional
  61 services and high-performance embedded I/O applications will achieve
  62 significant performance improvements resulting in reduced completion
  63 time and lower cost per operation.
  64 .Sh HARDWARE
  65 The
  66 .Nm
  67 driver supports the following network adapters:
  68 .Pp
  69 .Bl -bullet -compact
  70 .It
  71 Mellanox ConnectX-2 (ETH)
  72 .It
  73 Mellanox ConnectX-3 (ETH)
  74 .El
  75 .Sh SUPPORT
  76 For general information and support,
  77 go to the Mellanox support website at:
  78 .Pa http://www.mellanox.com/ .
  79 .Pp
  80 If an issue is identified with this driver with a supported adapter,
  81 email all the specific information related to the issue to
  82 .Aq Mt freebsd-drivers@mellanox.com .
  83 .Sh SEE ALSO
  84 .Xr ifconfig 8
  85 .Sh HISTORY
  86 The
  87 .Nm
  88 device driver first appeared in
  89 .Fx 9.x .
  90 .Sh AUTHORS
  91 .An -nosplit
  92 The
  93 .Nm
  94 driver was written by
  95 .An Mellanox Technologies <freebsd-drivers@mellanox.com> .