diff options
Diffstat (limited to 'static/freebsd/man4/mlx5en.4 3.html')
| -rw-r--r-- | static/freebsd/man4/mlx5en.4 3.html | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/static/freebsd/man4/mlx5en.4 3.html b/static/freebsd/man4/mlx5en.4 3.html new file mode 100644 index 00000000..0b4b19e5 --- /dev/null +++ b/static/freebsd/man4/mlx5en.4 3.html @@ -0,0 +1,115 @@ +<table class="head"> + <tr> + <td class="head-ltitle">MLX5EN(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">MLX5EN(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">mlx5en</code> — <span class="Nd">NVIDIA + Mellanox ConnectX-4/5/6 [Dx/Ex/Lx] based 200Gb, 100Gb, 50Gb, 40Gb, 25Gb and + 10Gb ethernet adapter driver</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp">To compile this driver into the kernel, place the following lines + in your kernel configuration file:</p> +<div class="Bd Pp Bd-indent"><code class="Cd">options COMPAT_LINUXKPI</code> +<br/> +<code class="Cd">options RATELIMIT</code> +<br/> +<code class="Cd">options KERN_TLS</code> +<br/> +<code class="Cd">device xz</code> +<br/> +<code class="Cd">device mlxfw</code> +<br/> +<code class="Cd">device firmware</code> +<br/> +<code class="Cd">device mlx5</code> +<br/> +<code class="Cd">device mlx5en</code></div> +<p class="Pp">To load the driver as a module at run-time, run the following + command as root:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>kldload mlx5en</pre> +</div> +<p class="Pp">To load the driver as a module at boot time, place the following + lines in <a class="Xr">loader.conf(5)</a>:</p> +<div class="Bd Pp Bd-indent Li"> +<pre>mlx5en_load="YES"</pre> +</div> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">mlx5en</code> driver provides support for PCI + Express Ethernet adapters based on ConnectX-4/5/6 [Dx, Ex and Lx variants]. + The driver supports Jumbo Frames, Transmit and Receive checksum offload, TCP + segmentation offload (TSO), Large Receive Offload (LRO), HW Large Receive + Offload (HW LRO), VLAN tag insertion and extraction, VLAN checksum offload, + VLAN TSO, hardware rate limiting (TXRTLMT), stateless VxLAN hardware offload + for receive and transmit, HW TLS offload for transmit, Receive Side Steering + (RSS) and <a class="Xr">numa(4)</a> awareness.</p> +<p class="Pp">The network interface name is <code class="Dv">mce<N></code> + which corresponds to a PCI function, + <code class="Dv">mlx_core<N></code>, where + <code class="Dv"><N></code> is a number starting at zero. There is at + most one network interface per PCI function.</p> +<p class="Pp">For further information and questions related to hardware + requirements, see <span class="Pa">https://www.mellanox.com</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1> +<p class="Pp">The <code class="Nm">mlx5en</code> driver supports 200Gb, 100Gb, + 50Gb, 40Gb, 25Gb and 10Gb ethernet adapters.</p> +<p class="Pp"></p> +<ul class="Bl-bullet Bl-compact"> + <li>ConnectX-6 supports 10/20/25/40/50/56/100Gb/200Gb/s speeds.</li> + <li>ConnectX-5 supports 10/20/25/40/50/56/100Gb/s speeds.</li> + <li>ConnectX-4 supports 10/20/25/40/50/56/100Gb/s speeds.</li> + <li>ConnectX-4 LX supports 10/25/40/50Gb/s speeds and reduced power + consumption.</li> +</ul> +</section> +<section class="Sh"> +<h1 class="Sh" id="CONFIGURATION"><a class="permalink" href="#CONFIGURATION">CONFIGURATION</a></h1> +<p class="Pp">The <code class="Nm">mlx5en</code> network interface is configured + using <a class="Xr">ifconfig(8)</a> and the <a class="Xr">sysctl(8)</a> tree + at <code class="Dv">dev.mce.<N></code>. All configurable entries are + also tunables, and can be put directly into the + <a class="Xr">loader.conf(5)</a> for persistent configuration.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SUPPORT"><a class="permalink" href="#SUPPORT">SUPPORT</a></h1> +<p class="Pp">For general information and support, go to the NVIDIA Mellanox + networking support website at: + <span class="Pa">https://www.mellanox.com</span>.</p> +<p class="Pp">If an issue is identified with this driver using a supported + adapter, e-mail all the specific information related to the issue to + <<a class="Mt" href="mailto:nbu-freebsd-drivers@nvidia.com">nbu-freebsd-drivers@nvidia.com</a>>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">ifconfig(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">mlx5en</code> device driver first appeared in + <span class="Ux">FreeBSD 11.0</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp">The <code class="Nm">mlx5en</code> driver was written by + <span class="An">NVIDIA Mellanox networking + <nbu-freebsd-drivers@nvidia.com></span>.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">July 20, 2021</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |