summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorhselasky <hselasky@FreeBSD.org>2015-11-23 13:30:13 +0000
committerhselasky <hselasky@FreeBSD.org>2015-11-23 13:30:13 +0000
commitd375c5c34e4b7ea1266698177621d5ddcdcc5827 (patch)
tree2a4212d5020ae0b424e2079abf0ad37607e37881 /share/man
parent46bf4415744520f5faa866b6547448b1bcaccbd0 (diff)
downloadFreeBSD-src-d375c5c34e4b7ea1266698177621d5ddcdcc5827.zip
FreeBSD-src-d375c5c34e4b7ea1266698177621d5ddcdcc5827.tar.gz
MFC r291072, r291168 and r291169:
Add the mlx5 and mlx5en modules to the i386 and amd64 kernel builds by default and add a manual page for mlx5en. The mlx5 module contains shared code for both infiniband and ethernet. The mlx5en module contains specific code for ethernet functionality only. A mlx5ib module is in the works for infiniband support. Supported hardware: - ConnectX-4: 10/20/25/40/50/56/100Gb/s speeds. - ConnectX-4 LX: 10/25/40/50Gb/s speeds (low power consumption) Refer to the mlx5en(4) manual page for a comprehensive list. The team porting the mlx5 driver(s) to FreeBSD: - Hans Petter Selasky <hselasky@freebsd.org> - Oded Shanoon <odeds@mellanox.com> - Meny Yossefi <menyy@mellanox.com> - Shany Michaely <shanim@mellanox.com> - Shahar Klein <shahark@mellanox.com> - Daria Genzel <dariaz@mellanox.com> - Mark Bloch <markb@mellanox.com> Differential Revision: https://reviews.freebsd.org/D4163 Sponsored by: Mellanox Technologies
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/Makefile2
-rw-r--r--share/man/man4/mlx5en.4124
2 files changed, 126 insertions, 0 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index dad7ecd..01f3bf1 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -260,6 +260,7 @@ MAN= aac.4 \
mk48txx.4 \
mld.4 \
mlx.4 \
+ mlx5en.4 \
mly.4 \
mmc.4 \
mmcsd.4 \
@@ -636,6 +637,7 @@ MLINKS+=lp.4 plip.4
MLINKS+=malo.4 if_malo.4
MLINKS+=md.4 vn.4
MLINKS+=mem.4 kmem.4
+MLINKS+=mlx5en.4 mce.4
MLINKS+=mn.4 if_mn.4
MLINKS+=mos.4 if_mos.4
MLINKS+=msk.4 if_msk.4
diff --git a/share/man/man4/mlx5en.4 b/share/man/man4/mlx5en.4
new file mode 100644
index 0000000..03bb02c
--- /dev/null
+++ b/share/man/man4/mlx5en.4
@@ -0,0 +1,124 @@
+.\" Copyright (c) 2015 Mellanox Technologies
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd November 22, 2015
+.Dt mlx5en 4
+.Os
+.Sh NAME
+.Nm mlx5en
+.Nd "Mellanox ConnectX-4 and ConnectX-4 LX based 100Gb, 50Gb, 40Gb, 25Gb and 10Gb Ethernet adapter driver"
+.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "options COMPAT_LINUXKPI"
+.Cd "device mlx5"
+.Cd "device mlx5en"
+.Ed
+.Pp
+To load the driver as a
+module at boot time, place the following lines in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+mlx5en_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for PCI Express Ethernet adapters based on
+ConnectX-4 and ConnectX-4 LX.
+The driver supports Jumbo Frames, Transmit/Receive checksum offload,
+TCP segmentation offload (TSO), Large Receive Offload (LRO),
+HW Large Receive Offload (HW LRO), VLAN tag insertion/extraction,
+VLAN checksum offload, VLAN TSO, and Receive Side Steering (RSS).
+.br
+The network interface is named mce.
+.br
+For further hardware information and questions related to hardware
+requirements, see
+.Pa http://www.mellanox.com/ .
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Sh HARDWARE
+The
+.Nm
+driver supports 100Gb, 50Gb, 40Gb, 25Gb and 10Gb Ethernet adapters.
+ConnectX-4 supports:10/20/25/40/50/56/100Gb/s speeds.
+ConnectX-4 LX supports:10/25/40/50Gb/s speeds (and reduced power consumption) :
+.Pp
+.Bl -bullet -compact
+.It
+Mellanox MCX455A-ECAT
+.It
+Mellanox MCX456A-ECAT
+.It
+Mellanox MCX415A-CCAT
+.It
+Mellanox MCX416A-CCAT
+.It
+Mellanox MCX455A-FCAT
+.It
+Mellanox MCX456A-FCAT
+.It
+Mellanox MCX415A-BCAT
+.It
+Mellanox MCX416A-BCAT
+.It
+Mellanox MCX4131A-GCAT
+.It
+Mellanox MCX4131A-BCAT
+.It
+Mellanox MCX4121A-ACAT
+.It
+Mellanox MCX4111A-ACAT
+.It
+Mellanox MCX4121A-XCAT
+.It
+Mellanox MCX4111A-XCAT
+.El
+.Sh SUPPORT
+For general information and support,
+go to the Mellanox support website at:
+.Pa http://www.mellanox.com/ .
+.Pp
+If an issue is identified with this driver with a supported adapter,
+email all the specific information related to the issue to
+.Aq Mt freebsd-drivers@mellanox.com .
+.Sh SEE ALSO
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Fx 11.0 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Mellanox Technologies <freebsd-drivers@mellanox.com> .
OpenPOWER on IntegriCloud