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