xref: /freebsd/share/man/man4/mlx4ib.4 (revision cc68614da8232d8baaca0ae0d0dd8f890f06623e)
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 March 1, 2017
28.Dt MLX4IB 4
29.Os
30.Sh NAME
31.Nm mlx4ib
32.Nd "Mellanox ConnectX-3 10GbE/40GbE network adapter driver"
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place these lines in your kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "options COMPAT_LINUXKPI"
38.Cd "device mlx4"
39.Cd "device mlx4ib"
40.Ed
41.Pp
42To load the driver as a module at run-time,
43run this command as root:
44.Bd -literal -offset indent
45kldload mlx4ib
46.Ed
47.Pp
48To load the driver as a
49module at boot time, place this line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52mlx4ib_load="YES"
53.Ed
54.Sh DESCRIPTION
55Mellanox ConnectX adapter cards with Virtual Protocol Interconnect
56(VPI) provide the highest performing and most flexible interconnect
57solution for Enterprise Data Centers, High-Performance Computing, and
58Embedded environments.
59Clustered data bases, parallelized applications, transactional
60services and high-performance embedded I/O applications will achieve
61significant performance improvements resulting in reduced completion
62time and lower cost per operation.
63.Sh HARDWARE
64The
65.Nm
66driver supports the following network adapters:
67.Pp
68.Bl -bullet -compact
69.It
70Mellanox ConnectX-2 (IB)
71.It
72Mellanox ConnectX-3 (IB)
73.El
74.Sh SUPPORT
75For general information and support,
76go to the Mellanox support website at:
77.Lk http://www.mellanox.com/ .
78.Pp
79If an issue is identified with this driver and a supported network adapter,
80please email the specific information to
81.Aq Mt freebsd-drivers@mellanox.com .
82.Sh SEE ALSO
83.Xr mlx4en 4 ,
84.Xr ifconfig 8
85.Sh HISTORY
86The
87.Nm
88device driver first appeared in
89.Fx 9.x .
90.Sh AUTHORS
91.An -nosplit
92The
93.Nm
94driver was written by
95.An Mellanox Technologies <freebsd-drivers@mellanox.com> .
96