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