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