share/man/man4/mlx5ib.4

   1 .\" Copyright (c) 2017 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 August 23, 2017
  28 .Dt MLX5IB 4
  29 .Os
  30 .Sh NAME
  31 .Nm mlx5ib
  32 .Nd "Mellanox ConnectX-4 and ConnectX-4 LX based 100Gb, 50Gb, 40Gb, 25Gb and 10Gb network adapter driver"
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place these lines in your kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "options COMPAT_LINUXKPI"
  38 .Cd "device mlx5"
  39 .Cd "device mlx5ib"
  40 .Ed
  41 .Pp
  42 To load the driver as a module at run-time,
  43 run this command as root:
  44 .Bd -literal -offset indent
  45 kldload mlx5ib
  46 .Ed
  47 .Pp
  48 To load the driver as a
  49 module at boot time, place this line in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 mlx5ib_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for infiniband and Remote DMA over Converged Ethernet,
  58 RoCE, for PCI Express network adapters based on ConnectX-4 and ConnectX-4 LX.
  59 .br
  60 For further hardware information and questions related to hardware
  61 requirements, see
  62 .Pa http://www.mellanox.com/ .
  63 .Pp
  64 For more information on configuring this device, see
  65 .Xr ifconfig 8 .
  66 .Sh HARDWARE
  67 The
  68 .Nm
  69 driver supports 100Gb, 50Gb, 40Gb, 25Gb and 10Gb network adapters.
  70 ConnectX-4 supports: 10/20/25/40/50/56/100Gb/s speeds.
  71 ConnectX-4 LX supports: 10/25/40/50Gb/s speeds (and reduced power consumption):
  72 .Pp
  73 .Bl -bullet -compact
  74 .It
  75 Mellanox MCX455A-ECAT
  76 .It
  77 Mellanox MCX456A-ECAT
  78 .It
  79 Mellanox MCX415A-CCAT
  80 .It
  81 Mellanox MCX416A-CCAT
  82 .It
  83 Mellanox MCX455A-FCAT
  84 .It
  85 Mellanox MCX456A-FCAT
  86 .It
  87 Mellanox MCX415A-BCAT
  88 .It
  89 Mellanox MCX416A-BCAT
  90 .It
  91 Mellanox MCX4131A-GCAT
  92 .It
  93 Mellanox MCX4131A-BCAT
  94 .It
  95 Mellanox MCX4121A-ACAT
  96 .It
  97 Mellanox MCX4111A-ACAT
  98 .It
  99 Mellanox MCX4121A-XCAT
 100 .It
 101 Mellanox MCX4111A-XCAT
 102 .El
 103 .Sh SUPPORT
 104 For general information and support,
 105 go to the Mellanox support website at:
 106 .Pa http://www.mellanox.com/ .
 107 .Pp
 108 If an issue is identified with this driver with a supported adapter,
 109 email all the specific information related to the issue to
 110 .Aq Mt freebsd-drivers@mellanox.com .
 111 .Sh SEE ALSO
 112 .Xr mlx5en 4 ,
 113 .Xr ifconfig 8
 114 .Sh HISTORY
 115 The
 116 .Nm
 117 device driver first appeared in
 118 .Fx 12.x .
 119 .Sh AUTHORS
 120 .An -nosplit
 121 The
 122 .Nm
 123 driver was written by
 124 .An Mellanox Technologies <freebsd-drivers@mellanox.com> .