xref: /freebsd/share/man/man4/mlx4en.4 (revision e51c23d9fba07620d22b8704afa692f9a5dfe106)
197549c34SHans Petter Selasky.\" Copyright (c) 2016 Mellanox Technologies
297549c34SHans Petter Selasky.\" All rights reserved.
397549c34SHans Petter Selasky.\"
497549c34SHans Petter Selasky.\" Redistribution and use in source and binary forms, with or without
597549c34SHans Petter Selasky.\" modification, are permitted provided that the following conditions
697549c34SHans Petter Selasky.\" are met:
797549c34SHans Petter Selasky.\" 1. Redistributions of source code must retain the above copyright
897549c34SHans Petter Selasky.\"    notice, this list of conditions and the following disclaimer.
997549c34SHans Petter Selasky.\" 2. Redistributions in binary form must reproduce the above copyright
1097549c34SHans Petter Selasky.\"    notice, this list of conditions and the following disclaimer in the
1197549c34SHans Petter Selasky.\"    documentation and/or other materials provided with the distribution.
1297549c34SHans Petter Selasky.\"
1397549c34SHans Petter Selasky.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
1497549c34SHans Petter Selasky.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1597549c34SHans Petter Selasky.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1697549c34SHans Petter Selasky.\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
1797549c34SHans Petter Selasky.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1897549c34SHans Petter Selasky.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
1997549c34SHans Petter Selasky.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2097549c34SHans Petter Selasky.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2197549c34SHans Petter Selasky.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2297549c34SHans Petter Selasky.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2397549c34SHans Petter Selasky.\" SUCH DAMAGE.
2497549c34SHans Petter Selasky.\"
2597549c34SHans Petter Selasky.\" $FreeBSD$
2697549c34SHans Petter Selasky.\"
27*e51c23d9SEnji Cooper.Dd March 1, 2017
2897549c34SHans Petter Selasky.Dt MLX4EN 4
2997549c34SHans Petter Selasky.Os
3097549c34SHans Petter Selasky.Sh NAME
3197549c34SHans Petter Selasky.Nm mlx4en
3297549c34SHans Petter Selasky.Nd "Mellanox ConnectX-3 10GbE/40GbE network adapter driver"
3397549c34SHans Petter Selasky.Sh SYNOPSIS
3497549c34SHans Petter SelaskyTo compile this driver into the kernel,
35*e51c23d9SEnji Cooperplace these lines in your kernel configuration file:
3697549c34SHans Petter Selasky.Bd -ragged -offset indent
3797549c34SHans Petter Selasky.Cd "options COMPAT_LINUXKPI"
3897549c34SHans Petter Selasky.Cd "device mlx4"
3997549c34SHans Petter Selasky.Cd "device mlx4en"
4097549c34SHans Petter Selasky.Ed
4197549c34SHans Petter Selasky.Pp
4297549c34SHans Petter SelaskyTo load the driver as a module at run-time,
43*e51c23d9SEnji Cooperrun this command as root:
4497549c34SHans Petter Selasky.Bd -literal -offset indent
4597549c34SHans Petter Selaskykldload mlx4en
4697549c34SHans Petter Selasky.Ed
4797549c34SHans Petter Selasky.Pp
4897549c34SHans Petter SelaskyTo load the driver as a
49*e51c23d9SEnji Coopermodule at boot time, place this line in
5097549c34SHans Petter Selasky.Xr loader.conf 5 :
5197549c34SHans Petter Selasky.Bd -literal -offset indent
5297549c34SHans Petter Selaskymlx4en_load="YES"
5397549c34SHans Petter Selasky.Ed
5497549c34SHans Petter Selasky.Sh DESCRIPTION
5597549c34SHans Petter SelaskyMellanox ConnectX adapter cards with Virtual Protocol Interconnect
5697549c34SHans Petter Selasky(VPI) provide the highest performing and most flexible interconnect
5797549c34SHans Petter Selaskysolution for Enterprise Data Centers, High-Performance Computing, and
5897549c34SHans Petter SelaskyEmbedded environments.
5997549c34SHans Petter SelaskyClustered data bases, parallelized applications, transactional
6097549c34SHans Petter Selaskyservices and high-performance embedded I/O applications will achieve
6197549c34SHans Petter Selaskysignificant performance improvements resulting in reduced completion
6297549c34SHans Petter Selaskytime and lower cost per operation.
6397549c34SHans Petter Selasky.Sh HARDWARE
6497549c34SHans Petter SelaskyThe
6597549c34SHans Petter Selasky.Nm
6697549c34SHans Petter Selaskydriver supports the following network adapters:
6797549c34SHans Petter Selasky.Pp
6897549c34SHans Petter Selasky.Bl -bullet -compact
6997549c34SHans Petter Selasky.It
7097549c34SHans Petter SelaskyMellanox ConnectX-2 (ETH)
7197549c34SHans Petter Selasky.It
7297549c34SHans Petter SelaskyMellanox ConnectX-3 (ETH)
7397549c34SHans Petter Selasky.El
7497549c34SHans Petter Selasky.Sh SUPPORT
7597549c34SHans Petter SelaskyFor general information and support,
7697549c34SHans Petter Selaskygo to the Mellanox support website at:
77*e51c23d9SEnji Cooper.Lk http://www.mellanox.com/ .
7897549c34SHans Petter Selasky.Pp
79*e51c23d9SEnji CooperIf an issue is identified with this driver and a supported network adapter,
80*e51c23d9SEnji Cooperplease email the specific information to
8197549c34SHans Petter Selasky.Aq Mt freebsd-drivers@mellanox.com .
8297549c34SHans Petter Selasky.Sh SEE ALSO
83de3506afSEnji Cooper.Xr mlx4ib 4 ,
8497549c34SHans Petter Selasky.Xr ifconfig 8
8597549c34SHans Petter Selasky.Sh HISTORY
8697549c34SHans Petter SelaskyThe
8797549c34SHans Petter Selasky.Nm
8897549c34SHans Petter Selaskydevice driver first appeared in
8997549c34SHans Petter Selasky.Fx 9.x .
9097549c34SHans Petter Selasky.Sh AUTHORS
9197549c34SHans Petter Selasky.An -nosplit
9297549c34SHans Petter SelaskyThe
9397549c34SHans Petter Selasky.Nm
9497549c34SHans Petter Selaskydriver was written by
9597549c34SHans Petter Selasky.An Mellanox Technologies <freebsd-drivers@mellanox.com> .
96