Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/mlx5en.4
.\" Copyright (c) 2015 Mellanox Technologies | .\" Copyright (c) 2015 Mellanox Technologies | ||||||||
.\" Copyright (c) 2021 NVIDIA corporation & affiliates | |||||||||
.\" All rights reserved. | .\" All rights reserved. | ||||||||
.\" | .\" | ||||||||
.\" Redistribution and use in source and binary forms, with or without | .\" Redistribution and use in source and binary forms, with or without | ||||||||
.\" modification, are permitted provided that the following conditions | .\" modification, are permitted provided that the following conditions | ||||||||
.\" are met: | .\" are met: | ||||||||
.\" 1. Redistributions of source code must retain the above copyright | .\" 1. Redistributions of source code must retain the above copyright | ||||||||
.\" notice, this list of conditions and the following disclaimer. | .\" notice, this list of conditions and the following disclaimer. | ||||||||
.\" 2. Redistributions in binary form must reproduce the above copyright | .\" 2. Redistributions in binary form must reproduce the above copyright | ||||||||
Show All 9 Lines | |||||||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" 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 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||||||
.\" | .\" | ||||||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||||||
.\" | .\" | ||||||||
.Dd May 8, 2019 | .Dd July 20, 2021 | ||||||||
.Dt MLX5EN 4 | .Dt MLX5EN 4 | ||||||||
.Os | .Os | ||||||||
.Sh NAME | .Sh NAME | ||||||||
.Nm mlx5en | .Nm mlx5en | ||||||||
.Nd "Mellanox ConnectX-4, ConnectX-4 LX and ConnectX-5 based 100Gb, 50Gb, 40Gb, 25Gb and 10Gb Ethernet adapter driver" | .Nd "Mellanox ConnectX-4/5/6 [Dx/Ex/Lx] based 200Gb, 100Gb, 50Gb, 40Gb, 25Gb and 10Gb ethernet adapter driver" | ||||||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||||||
To compile this driver into the kernel, | To compile this driver into the kernel, | ||||||||
place the following lines in your | place the following lines in your | ||||||||
kernel configuration file: | kernel configuration file: | ||||||||
.Bd -ragged -offset indent | .Bd -ragged -offset indent | ||||||||
.Cd "options COMPAT_LINUXKPI" | .Cd "options COMPAT_LINUXKPI" | ||||||||
.Cd "options RATELIMIT" | .Cd "options RATELIMIT" | ||||||||
.Cd "options KERN_TLS" | |||||||||
.Cd "device xz" | .Cd "device xz" | ||||||||
.Cd "device mlxfw" | .Cd "device mlxfw" | ||||||||
.Cd "device firmware" | .Cd "device firmware" | ||||||||
.Cd "device mlx5" | .Cd "device mlx5" | ||||||||
.Cd "device mlx5en" | .Cd "device mlx5en" | ||||||||
.Ed | .Ed | ||||||||
.Pp | .Pp | ||||||||
To load the driver as a module at run-time, | To load the driver as a module at run-time, | ||||||||
run the following command as root: | run the following command as root: | ||||||||
.Bd -literal -offset indent | .Bd -literal -offset indent | ||||||||
kldload mlx5en | kldload mlx5en | ||||||||
.Ed | .Ed | ||||||||
.Pp | .Pp | ||||||||
To load the driver as a | To load the driver as a | ||||||||
module at boot time, place the following lines in | module at boot time, place the following lines in | ||||||||
.Xr loader.conf 5 : | .Xr loader.conf 5 : | ||||||||
.Bd -literal -offset indent | .Bd -literal -offset indent | ||||||||
mlx5en_load="YES" | mlx5en_load="YES" | ||||||||
.Ed | .Ed | ||||||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||||||
The | The | ||||||||
.Nm | .Nm | ||||||||
driver provides support for PCI Express Ethernet adapters based on | driver provides support for PCI Express Ethernet adapters based on | ||||||||
ConnectX-4, ConnectX-4 LX and ConnectX-5. | ConnectX-4/5/6 [Dx, Ex and Lx variants]. | ||||||||
The driver supports Jumbo Frames, Transmit/Receive checksum offload, | The driver supports Jumbo Frames, Transmit and Receive checksum offload, | ||||||||
TCP segmentation offload (TSO), Large Receive Offload (LRO), | TCP segmentation offload (TSO), Large Receive Offload (LRO), | ||||||||
HW Large Receive Offload (HW LRO), VLAN tag insertion/extraction, | HW Large Receive Offload (HW LRO), VLAN tag insertion and extraction, | ||||||||
VLAN checksum offload, VLAN TSO, hardware rate limiting (TXRTLMT) | VLAN checksum offload, VLAN TSO, hardware rate limiting (TXRTLMT), | ||||||||
and Receive Side Steering (RSS). | VxLAN hardware offload for receive and transmit, | ||||||||
kibUnsubmitted Done Inline Actions
kib: | |||||||||
.br | HW TLS offload for transmit, Receive Side Steering (RSS) and | ||||||||
The network interface is named mce. | .Xr NUMA 4 | ||||||||
.br | awareness. | ||||||||
.Pp | |||||||||
The network interface name is mce<N>. | |||||||||
Done Inline Actions.Dv mce<N> Also, the most puzzling part for a newby is to understand that PCI attachment names the device mlx_core<N>. kib: .Dv mce<N>
not sure if some minimal elaboration of the meaning of <N> is useful.
Also, the… | |||||||||
.Pp | |||||||||
For further hardware information and questions related to hardware | For further hardware information and questions related to hardware | ||||||||
requirements, see | requirements, see | ||||||||
.Pa http://www.mellanox.com/ . | .Pa http://www.mellanox.com/ . | ||||||||
kibUnsubmitted Done Inline ActionsIs this right URL? kib: Is this right URL? | |||||||||
hselaskyAuthorUnsubmitted Done Inline ActionsYes, I see no other yet. hselasky: Yes, I see no other yet. | |||||||||
.Pp | .Pp | ||||||||
For more information on configuring this device, see | For more information on configuring this device, see | ||||||||
.Xr ifconfig 8 . | .Xr ifconfig 8 . | ||||||||
.Sh HARDWARE | .Sh HARDWARE | ||||||||
The | The | ||||||||
.Nm | .Nm | ||||||||
driver supports 100Gb, 50Gb, 40Gb, 25Gb and 10Gb Ethernet adapters. | driver supports 200Gb, 100Gb, 50Gb, 40Gb, 25Gb and 10Gb ethernet adapters. | ||||||||
ConnectX-5 supports:10/20/25/40/50/56/100Gb/s speeds. | |||||||||
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 | .Bl -bullet -compact | ||||||||
.Pp | |||||||||
.It | .It | ||||||||
Mellanox MCX455A-ECAT | ConnectX-6 supports 10/20/25/40/50/56/100Gb/200Gb/s speeds. | ||||||||
.It | .It | ||||||||
Mellanox MCX456A-ECAT | ConnectX-5 supports 10/20/25/40/50/56/100Gb/s speeds. | ||||||||
.It | .It | ||||||||
Mellanox MCX415A-CCAT | ConnectX-4 supports 10/20/25/40/50/56/100Gb/s speeds. | ||||||||
.It | .It | ||||||||
Mellanox MCX416A-CCAT | ConnectX-4 LX supports 10/25/40/50Gb/s speeds and reduced power consumption. | ||||||||
.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 | .El | ||||||||
.Sh CONFIGURATION | |||||||||
The | |||||||||
.Nm | |||||||||
driver is configured using the | |||||||||
.Xr sysctl 8 | |||||||||
tree at dev.mce.<N> . | |||||||||
kibUnsubmitted Done Inline Actions.Dv dev.mce.<N> . kib: .Dv dev.mce.<N> . | |||||||||
All configurable entries are also tunables, and can be put directly into | |||||||||
.Xr loader.conf 5 | |||||||||
for persistant configuration. | |||||||||
kibUnsubmitted Done Inline Actionspersistent? kib: persistent? | |||||||||
.Sh SUPPORT | .Sh SUPPORT | ||||||||
For general information and support, | For general information and support, | ||||||||
go to the Mellanox support website at: | go to the Mellanox support website at: | ||||||||
kibUnsubmitted Done Inline ActionsNvidia networking? kib: Nvidia networking? | |||||||||
hselaskyAuthorUnsubmitted Done Inline ActionsNVIDIA Mellanox networking. Mellanox is still a brand from what I know. hselasky: NVIDIA Mellanox networking. Mellanox is still a brand from what I know. | |||||||||
.Pa http://www.mellanox.com/ . | .Pa https://www.mellanox.com . | ||||||||
kibUnsubmitted Done Inline ActionsIs it right URL? kib: Is it right URL? | |||||||||
hselaskyAuthorUnsubmitted Done Inline ActionsYes, for now. hselasky: Yes, for now. | |||||||||
.Pp | .Pp | ||||||||
If an issue is identified with this driver with a supported adapter, | If an issue is identified with this driver using a supported adapter, | ||||||||
email all the specific information related to the issue to | e-mail all the specific information related to the issue to | ||||||||
.Aq Mt freebsd-drivers@mellanox.com . | .Aq Mt freebsd-drivers@mellanox.com . | ||||||||
.Sh SEE ALSO | .Sh SEE ALSO | ||||||||
.Xr ifconfig 8 | .Xr ifconfig 8 | ||||||||
.Sh HISTORY | .Sh HISTORY | ||||||||
The | The | ||||||||
.Nm | .Nm | ||||||||
device driver first appeared in | device is driver is available in | ||||||||
.Fx 11.0 . | .Fx 10-stable, 11.0, 12.0 and newer . | ||||||||
kibUnsubmitted Done Inline ActionsI think a reference to 10.0 is too late. The note about 'first appeared' cannot be changed by retrospective MFC, so keep it as is. kib: I think a reference to 10.0 is too late. The note about 'first appeared' cannot be changed by… | |||||||||
.Sh AUTHORS | .Sh AUTHORS | ||||||||
.An -nosplit | .An -nosplit | ||||||||
The | The | ||||||||
.Nm | .Nm | ||||||||
driver was written by | driver was written by | ||||||||
.An Mellanox Technologies <freebsd-drivers@mellanox.com> . | .An Mellanox Technologies <freebsd-drivers@mellanox.com> | ||||||||
kibUnsubmitted Done Inline ActionsIs this right email? kib: Is this right email? | |||||||||
also known as NVIDIA Networking. |