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