Changeset View
Changeset View
Standalone View
Standalone View
share/man/man4/ixlv.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 IXLV 4 | .Dt IXLV 4 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm ixlv | .Nm ixlv | ||||
.Nd "Intel XL710 Ethernet 40Gb VF driver" | .Nd "Intel Ethernet 700 Series VF 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 ixlv" | .Cd "device ixlv" | ||||
.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_ixlv_load="YES" | if_ixlv_load="YES" | ||||
.Ed | .Ed | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
The | The | ||||
.Nm | .Nm | ||||
driver provides virtualization support for PCI Express adapters | driver provides support for the PCI Virtual Functions from the 700 Series of | ||||
or LOMs in the XL710 Family of ethernet devices. | ethernet devices. | ||||
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 . | ||||
.Pp | .Pp | ||||
.Em NOTE : | .Em NOTE : | ||||
The | This | ||||
.Nm | .Nm | ||||
driver is only used by means of SRIOV, normally in a VM on a | driver is only for Virtual Functions. | ||||
hosting server with the | For Physical Functions, use the | ||||
.Xr ixl 4 | .Xr ixl 4 | ||||
driver. | driver. | ||||
.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.ixlv.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.ixlv.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.ixlv.txbrsz | |||||
Set the size of the buff ring used by the transmit side of the | |||||
stack, we have found that it is necessary to have it quite large | |||||
in order to get UDP to perform well. | |||||
.It Va hw.ixlv.dynamic_rx_itr | |||||
The dynamic RX interrupt control, set to 1 to enable, off by default. | |||||
.It Va hw.ixlv.dynamic_tx_itr | |||||
The dynamic TX interrupt control, set to 1 to enable, off by default. | |||||
.It Va hw.ixlv.rx_itr | .It Va hw.ixlv.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.ixlv.tx_itr | .It Va hw.ixlv.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.ixlv.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. | |||||
Disabled by default; this mimics the TX behavior found in | |||||
.Xr ixgbe 4 . | |||||
.El | .El | ||||
.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 ixl 4 , | .Xr ixl 4 , | ||||
.Xr netintro 4 , | .Xr netintro 4 , | ||||
.Xr ng_ether 4 , | |||||
.Xr vlan 4 , | .Xr vlan 4 , | ||||
.Xr ifconfig 8 | .Xr ifconfig 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 . | ||||
.Sh CAVEATS | |||||
This driver may function on VFs spawned from future network devices by Intel, | |||||
but it is currently only supported on the 700 series VFs. |