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