Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/ixl.4
.\" Copyright (c) 2013-2015, Intel Corporation | .\" Copyright (c) 2013-2018, Intel Corporation | ||||
.\" 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 are met: | .\" modification, are permitted provided that the following conditions are met: | ||||
.\" | .\" | ||||
.\" 1. Redistributions of source code must retain the above copyright notice, | .\" 1. Redistributions of source code must retain the above copyright notice, | ||||
.\" this list of conditions and the following disclaimer. | .\" this list of conditions and the following disclaimer. | ||||
.\" | .\" | ||||
Show All 16 Lines | |||||
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||||
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | ||||
.\" POSSIBILITY OF SUCH DAMAGE. | .\" POSSIBILITY OF SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" * Other names and brands may be claimed as the property of others. | .\" * Other names and brands may be claimed as the property of others. | ||||
.\" | .\" | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd March 25, 2015 | .Dd October 2, 2018 | ||||
.Dt IXL 4 | .Dt IXL 4 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm ixl | .Nm ixl | ||||
.Nd "Intel XL710 Ethernet 40Gb Base driver" | .Nd "Intel Ethernet 700 Series 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 "device ixl" | .Cd "device ixl" | ||||
.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 | ||||
if_ixl_load="YES" | if_ixl_load="YES" | ||||
.Ed | .Ed | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
.Ss Features | |||||
The | The | ||||
.Nm | .Nm | ||||
driver provides support for PCI Express adapters or LOMs | driver provides support for any PCI Express adapter or LOM | ||||
in the XL710 Family of ethernet devices. | (LAN On Motherboard) | ||||
in the Intel Ethernet 700 Series. | |||||
As of this writing, the series includes devices with these model numbers: | |||||
.Pp | |||||
.Bl -bullet -compact | |||||
.It | |||||
XL710 (40G) | |||||
.It | |||||
X710 (10G) | |||||
.It | |||||
XXV710 (25G) | |||||
.It | |||||
X722 (10G) | |||||
.El | |||||
.Pp | |||||
The driver supports Jumbo Frames, TX/RX checksum offload, | The driver supports Jumbo Frames, TX/RX checksum offload, | ||||
TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN | TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN | ||||
tag insertion/extraction, VLAN checksum offload, VLAN TSO, and | tag insertion/extraction, VLAN checksum offload, VLAN TSO, and | ||||
Receive Side Steering (RSS), all for both IPv4 and IPv6. | Receive Side Steering (RSS), all for both IPv4 and IPv6. | ||||
For further hardware information and questions related to hardware | For further hardware information and questions related to hardware | ||||
requirements, see | requirements, see | ||||
.Pa http://support.intel.com/ . | .Pa http://support.intel.com/ . | ||||
.Pp | .Pp | ||||
Support for Jumbo Frames is provided via the interface MTU setting. | Support for Jumbo Frames is provided via the interface MTU setting. | ||||
Selecting an MTU larger than 1500 bytes with the | Selecting an MTU larger than 1500 bytes with the | ||||
.Xr ifconfig 8 | .Xr ifconfig 8 | ||||
utility configures the adapter to receive and transmit Jumbo Frames. | utility configures the adapter to receive and transmit Jumbo Frames. | ||||
The maximum MTU size for Jumbo Frames is 9706. | The maximum MTU size for Jumbo Frames is 9706. | ||||
.Pp | .Pp | ||||
Offloads are also controlled via the interface, for instance, | Offloads are also controlled via the interface, for instance, | ||||
checksumming for both IPv4 and IPv6 can be set and unset, TSO4 | checksumming for both IPv4 and IPv6 can be set and unset, TSO4 | ||||
and/or TSO6, and finally LRO can be set and unset. | and/or TSO6, and finally LRO can be set and unset. | ||||
.Pp | .Pp | ||||
For more information on configuring this device, see | For more information on configuring this device, see | ||||
.Xr ifconfig 8 . | .Xr ifconfig 8 . | ||||
.Ss Additional Utilities | |||||
There are additional tools available from Intel to help configure and update | |||||
the adapters covered by this driver. | |||||
These tools can be downloaded directly from Intel at | |||||
.Pa downloadcenter.intel.com , | |||||
by searching for their names, or by installing certain packages: | |||||
.Bl -item | |||||
.It | |||||
To change the behavior of the QSFP+ ports on XL710 adapters, use the | |||||
Intel QCU (QSFP+ configuration utility); installed by the | |||||
.Em sysutils/intel-qcu | |||||
package. | |||||
.It | |||||
To update the firmware on an adapter, use the Intel Non-Volatile Memory (NVM) | |||||
Update Utility; installed by the | |||||
.Em sysutils/intel-nvmupdate | |||||
package. | |||||
.It | |||||
Drivers are provided by Intel outside of the | |||||
.Fx | |||||
0mp: This is not really correct.
It should be
```
.Fx
kernel;
```
because otherwise `kernel` is… | |||||
kernel; install the | |||||
.Em net/intel-ixl-kmod | |||||
package for the latest driver. | |||||
.El | |||||
.Sh HARDWARE | .Sh HARDWARE | ||||
Most adapters in the Intel Ethernet 700 Series with SFP+/SFP28/QSFP+ cages | |||||
have firmware that requires that Intel qualified modules are used; these | |||||
qualified modules are listed below. | |||||
This qualification check cannot be disabled by the driver. | |||||
.Pp | |||||
The | The | ||||
.Nm | .Nm | ||||
driver supports these SFP+ Pluggable Optics: | driver supports 40Gb Ethernet adapters with these QSFP+ modules: | ||||
.Pp | .Pp | ||||
.Bl -bullet -compact | .Bl -bullet -compact | ||||
.It | .It | ||||
Intel TRIPLE RATE 1G/10G/40G QSFP+ SR (bailed) E40GQSFPSR | Intel 4x10G/40G QSFP+ 40GBASE-SR4 E40GQSFPSR | ||||
.It | .It | ||||
Intel TRIPLE RATE 1G/10G/40G QSFP+ SR (bailed) E40GQSFPLR | Intel 4x10G/40G QSFP+ 40GBASE-LR4 E40GQSFPLR | ||||
.El | .El | ||||
.Pp | .Pp | ||||
The | The | ||||
.Nm | .Nm | ||||
driver supports 10Gb and 1Gb Ethernet adapters with SR Modules: | driver supports 25Gb Ethernet adapters with these SFP28 modules: | ||||
.Pp | .Pp | ||||
.Bl -bullet -compact | .Bl -bullet -compact | ||||
.It | .It | ||||
Intel DUAL RATE 1G/10G SFP+ SR (bailed) FTLX8571D3BCV-IT | Intel 10G/25G SFP28 25GBASE-SR E25GSFP28SR | ||||
.It | .It | ||||
Intel DUAL RATE 1G/10G SFP+ SR (bailed) AFBR-703SDZ-IN2 | Intel 10G/25G SFP28 25GBASE-SR E25GSFP28SRX (Extended Temp) | ||||
.El | .El | ||||
.Pp | .Pp | ||||
The | The | ||||
.Nm | .Nm | ||||
driver supports 10Gb and 1Gb Ethernet adapters with LR Modules: | driver supports 25Gb and 10Gb Ethernet adapters with these SFP+ modules: | ||||
.Pp | .Pp | ||||
.Bl -bullet -compact | .Bl -bullet -compact | ||||
.It | .It | ||||
Intel DUAL RATE 1G/10G SFP+ LR (bailed) FTLX1471D3BCV-IT | Intel 1G/10G SFP+ SR FTLX8571D3BCV-IT | ||||
.It | .It | ||||
Intel DUAL RATE 1G/10G SFP+ LR (bailed) AFCT-701SDZ-IN2 | Intel 1G/10G SFP+ SR AFBR-703SDZ-IN2 | ||||
.It | |||||
Intel 1G/10G SFP+ LR FTLX1471D3BCV-IT | |||||
.It | |||||
Intel 1G/10G SFP+ LR AFCT-701SDZ-IN2 | |||||
.It | |||||
Intel 1G/10G SFP+ 10GBASE-SR E10GSFPSR | |||||
.It | |||||
Intel 10G SFP+ 10GBASE-SR E10GSFPSRX (Extended Temp) | |||||
.It | |||||
Intel 1G/10G SFP+ 10GBASE-LR E10GSFPLR | |||||
.El | .El | ||||
.Pp | .Pp | ||||
Note that X710/XL710 Based SFP+ adapters also support all passive and active | Note that adapters also support all passive and active | ||||
limiting direct attach cables that comply with SFF-8431 v4.1 and | limiting direct attach cables that comply with SFF-8431 v4.1 and | ||||
SFF-8472 v10.4 specifications. | SFF-8472 v10.4 specifications. | ||||
.Pp | |||||
This is not an exhaustive list; please consult product documentation for an | |||||
up-to-date list of supported media. | |||||
.Sh LOADER TUNABLES | .Sh LOADER TUNABLES | ||||
Tunables can be set at the | Tunables can be set at the | ||||
.Xr loader 8 | .Xr loader 8 | ||||
prompt before booting the kernel or stored in | prompt before booting the kernel or stored in | ||||
.Xr loader.conf 5 . | .Xr loader.conf 5 . | ||||
.Bl -tag -width indent | .Bl -tag -width indent | ||||
.It Va hw.ixl.enable_msix | |||||
Allows one to enable/disable MSIX, thus forcing MSI instead. | |||||
.It Va hw.ixl.ringsz | |||||
Set the number of descriptors in the rings, note that this | |||||
changes BOTH the TX and RX rings, they cannot be set independently. | |||||
.It Va hw.ixl.max_queues | |||||
Set the number of queues (each a TX/RX pair) for the port, this | |||||
allows one to override the autocalculation if it is set to 0. | |||||
.It Va hw.ixl.dynamic_rx_itr | |||||
The dynamic RX interrupt control, set to 1 to enable. | |||||
.It Va hw.ixl.dynamic_tx_itr | |||||
The dynamic TX interrupt control, set to 1 to enable. | |||||
.It Va hw.ixl.rx_itr | .It Va hw.ixl.rx_itr | ||||
The RX interrupt rate value, set to 8K by default. | The RX interrupt rate value, set to 62 (124 usec) by default. | ||||
.It Va hw.ixl.tx_itr | .It Va hw.ixl.tx_itr | ||||
The TX interrupt rate value, set to 4K by default. | The TX interrupt rate value, set to 122 (244 usec) by default. | ||||
.It Va hw.ixl.i2c_access_method | |||||
Access method that driver will use for I2C read and writes via | |||||
Done Inline Actions.Xr 8 sysctl 0mp: `.Xr 8 sysctl` | |||||
.Xr sysctl 8 | |||||
or verbose | |||||
.Xr ifconfig 8 | |||||
information display: | |||||
.Bd -literal -offset indent | |||||
Done Inline ActionsShoudn't it be a Bd or Bl? 0mp: Shoudn't it be a `Bd` or `Bl`? | |||||
0 - best available method | |||||
1 - bit bang via I2CPARAMS register | |||||
2 - register read/write via I2CCMD register | |||||
3 - Use Admin Queue command (default best) | |||||
.Ed | |||||
.Pp | |||||
Using the Admin Queue is only supported on 710 devices with FW version 1.7 or | |||||
newer. | |||||
Set to 0 by default. | |||||
.It Va hw.ixl.enable_tx_fc_filter | |||||
Done Inline ActionsMan page style is to start a new line when starting a new sentence. bjk: Man page style is to start a new line when starting a new sentence. | |||||
Filter out packets with Ethertype 0x8808 from being sent out by non-adapter | |||||
sources. | |||||
This prevents (potentially untrusted) software or | |||||
.Xr ixlv 4 | |||||
devices from sending out flow control packets and creating a DoS (Denial of | |||||
Service) event. | |||||
Enabled by default. | |||||
.It Va hw.ixl.enable_head_writeback | |||||
When the driver is finding the last TX descriptor processed by the hardware, | |||||
use a value written to memory by the hardware instead of scanning the | |||||
descriptor ring for completed descriptors. | |||||
Enabled by default; disable to mimic the TX behavior found in | |||||
.Xr ixgbe 4 . | |||||
.El | .El | ||||
.Sh SYSCTL PROCEDURES | .Sh SYSCTL PROCEDURES | ||||
.Bl -tag -width indent | .Bl -tag -width indent | ||||
.It Va hw.ixl.fc | .It Va dev.ixl.#.fc | ||||
Allows one to set the flow control value. | Sets the 802.3x flow control mode that the adapter will advertise on the link. | ||||
A value of 0 disables | A value of 0 disables flow control, 3 enables full, 1 is RX, and 2 is TX pause. | ||||
flow control, 3 enables full, 1 is RX, and 2 is TX pause. | .Pp | ||||
.It Va hw.ixl.advertise_speed | The negotiated flow control setting can be viewed in | ||||
Allows one to set advertised link speeds, this will then | .Xr ifconfig 8 , | ||||
cause a link renegotiation. | in the interface's media field. | ||||
With the appropriate adapter | .It Va dev.ixl.#.advertise_speed | ||||
this can cause a link at 10GB, 1GB, or 100MB. | Set the speeds that the interface will advertise on the link. | ||||
.It Va hw.ixl.current_speed | .Va dev.ixl.#.supported_speeds | ||||
Done Inline Actions.Va dev.ixl.#.supported_speeds 0mp: `.Va dev.ixl.#.supported_speeds` | |||||
This is a display of the current setting. | contains the speeds that are allowed to be set. | ||||
.It Va hw.ixl.fw_version | .It Va dev.ixl.#.current_speed | ||||
This is a display of the Firmware version. | Displays the current speed. | ||||
.It Va dev.ixl.#.fw_version | |||||
Displays the current firmware and NVM versions of the adapter. | |||||
.El | .El | ||||
.Sh Interrupt Storms | .Sh INTERRUPT STORMS | ||||
It is important to note that 40G operation can generate high | It is important to note that 40G operation can generate high | ||||
numbers of interrupts, often incorrectly being interpreted as | numbers of interrupts, often incorrectly being interpreted as | ||||
a storm condition in the kernel. | a storm condition in the kernel. | ||||
It is suggested that this | It is suggested that this be resolved by setting: | ||||
be resolved by setting: | |||||
.Bl -tag -width indent | .Bl -tag -width indent | ||||
.It Va hw.intr_storm_threshold: 0 | .It Va hw.intr_storm_threshold: 0 | ||||
.El | .El | ||||
.Sh IOVCTL OPTIONS | |||||
The driver supports additional optional parameters for created VFs | |||||
(Virtual Functions) when using | |||||
.Xr iovctl 8 : | |||||
.Bl -tag -width indent | |||||
.It mac-addr Pq unicast-mac | |||||
Set the Ethernet MAC address that the VF will use. | |||||
If unspecified, the VF will use a randomly generated MAC address. | |||||
.It mac-anti-spoof Pq bool | |||||
Prevent the VF from sending Ethernet frames with a source address | |||||
that does not match its own. | |||||
.It allow-set-mac Pq bool | |||||
Allow the VF to set its own Ethernet MAC address | |||||
.It allow-promisc Pq bool | |||||
Done Inline ActionsWhy are we adding new commented-out code? bjk: Why are we adding new commented-out code? | |||||
Allow the VF to inspect all of the traffic sent to the port. | |||||
.It num-queues Pq uint16_t | |||||
Specify the number of queues the VF will have. | |||||
By default, this is set to the number of MSI-X vectors supported by the VF | |||||
minus one. | |||||
.El | |||||
.Pp | |||||
An up to date list of parameters and their defaults can be found by using | |||||
.Xr iovctl 8 | |||||
Done Inline ActionsXr 8 iovctl 0mp: `Xr 8 iovctl` | |||||
with the -S option. | |||||
.Sh SUPPORT | .Sh SUPPORT | ||||
For general information and support, | For general information and support, | ||||
go to the Intel support website at: | go to the Intel support website at: | ||||
.Pa http://support.intel.com/ . | .Pa http://support.intel.com/ . | ||||
.Pp | .Pp | ||||
If an issue is identified with this driver with a supported adapter, | If an issue is identified with this driver with a supported adapter, | ||||
email all the specific information related to the issue to | email all the specific information related to the issue to | ||||
.Aq freebsd@intel.com . | .Mt freebsd@intel.com . | ||||
.Sh SEE ALSO | .Sh SEE ALSO | ||||
.Xr arp 4 , | .Xr arp 4 , | ||||
.Xr ixlv 4 , | .Xr ixlv 4 , | ||||
.Xr netintro 4 , | .Xr netintro 4 , | ||||
.Xr ng_ether 4 , | |||||
.Xr vlan 4 , | .Xr vlan 4 , | ||||
.Xr ifconfig 8 | .Xr ifconfig 8 , | ||||
.Xr iovctl 8 , | |||||
.Xr iflib 9 | |||||
.Sh HISTORY | .Sh HISTORY | ||||
The | The | ||||
.Nm | .Nm | ||||
device driver first appeared in | device driver first appeared in | ||||
.Fx 10.1 . | .Fx 10.1 . | ||||
It was converted to use | |||||
.Xr iflib 9 | |||||
in | |||||
.Fx 12 . | |||||
.Sh AUTHORS | .Sh AUTHORS | ||||
.An -nosplit | .An -nosplit | ||||
The | The | ||||
.Nm | .Nm | ||||
driver was written by | driver was written by | ||||
.An Jack Vogel Aq Mt jfv@FreeBSD.org | .An Jack Vogel Aq Mt jfv@freebsd.org | ||||
and | and | ||||
.An Eric Joyner Aq Mt ricera10@gmail.com . | .An Eric Joyner Aq Mt erj@freebsd.org . |
This is not really correct.
It should be
because otherwise kernel is interpreted as a version of FreeBSD. It's easy to miss it as it does not affect the way this piece of text is presented by default in the terminal.
However, you may see that if you use mandoc -Thtml to generate an HTML file out of this manpage you'll get: