xref: /freebsd/share/man/man4/mlx5en.4 (revision 02e9120893770924227138ba49df1edb3896112a)
1.\" Copyright (c) 2015 Mellanox Technologies
2.\" Copyright (c) 2021 NVIDIA corporation & affiliates
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd July 20, 2021
27.Dt MLX5EN 4
28.Os
29.Sh NAME
30.Nm mlx5en
31.Nd "NVIDIA Mellanox ConnectX-4/5/6 [Dx/Ex/Lx] based 200Gb, 100Gb, 50Gb, 40Gb, 25Gb and 10Gb ethernet adapter driver"
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "options COMPAT_LINUXKPI"
38.Cd "options RATELIMIT"
39.Cd "options KERN_TLS"
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/5/6 [Dx, Ex and Lx variants].
64The driver supports Jumbo Frames, Transmit and Receive checksum offload,
65TCP segmentation offload (TSO), Large Receive Offload (LRO),
66HW Large Receive Offload (HW LRO), VLAN tag insertion and extraction,
67VLAN checksum offload, VLAN TSO, hardware rate limiting (TXRTLMT),
68stateless VxLAN hardware offload for receive and transmit,
69HW TLS offload for transmit, Receive Side Steering (RSS) and
70.Xr numa 4
71awareness.
72.Pp
73The network interface name is
74.Dv mce<N>
75which corresponds to a PCI function,
76.Dv mlx_core<N> ,
77where
78.Dv <N>
79is a number starting at zero.
80There is at most one network interface per PCI function.
81.Pp
82For further information and questions related to hardware
83requirements, see
84.Pa https://www.mellanox.com .
85.Sh HARDWARE
86The
87.Nm
88driver supports 200Gb, 100Gb, 50Gb, 40Gb, 25Gb and 10Gb ethernet adapters.
89.Pp
90.Bl -bullet -compact
91.It
92ConnectX-6 supports 10/20/25/40/50/56/100Gb/200Gb/s speeds.
93.It
94ConnectX-5 supports 10/20/25/40/50/56/100Gb/s speeds.
95.It
96ConnectX-4 supports 10/20/25/40/50/56/100Gb/s speeds.
97.It
98ConnectX-4 LX supports 10/25/40/50Gb/s speeds and reduced power consumption.
99.El
100.Sh CONFIGURATION
101The
102.Nm
103network interface is configured using
104.Xr ifconfig 8
105and the
106.Xr sysctl 8
107tree at
108.Dv dev.mce.<N> .
109All configurable entries are also tunables, and can be put directly into the
110.Xr loader.conf 5
111for persistent configuration.
112.Sh SUPPORT
113For general information and support,
114go to the NVIDIA Mellanox networking support website at:
115.Pa https://www.mellanox.com .
116.Pp
117If an issue is identified with this driver using a supported adapter,
118e-mail all the specific information related to the issue to
119.Aq Mt nbu-freebsd-drivers@nvidia.com .
120.Sh SEE ALSO
121.Xr ifconfig 8
122.Sh HISTORY
123The
124.Nm
125device driver first appeared in
126.Fx 11.0 .
127.Sh AUTHORS
128.An -nosplit
129The
130.Nm
131driver was written by
132.An NVIDIA Mellanox networking <nbu-freebsd-drivers@nvidia.com> .
133