diff options
| author | Kevin Bowling <kbowling@FreeBSD.org> | 2026-08-16 01:36:41 +0000 |
|---|---|---|
| committer | Kevin Bowling <kbowling@FreeBSD.org> | 2026-08-16 01:41:16 +0000 |
| commit | 1391e272de36f7aae2c800d96cc06762553d5027 (patch) | |
| tree | fb6f898ad1978c46ed42c3c64ce77c5fb230124a | |
| parent | f177ff939a91a3d710752438b13aff53d5afc725 (diff) | |
ixv(4): Add a manual page
Document supported virtual-function families, driver features, queue
negotiation, PF-controlled policy, and media limitations.
MFC after: 2 weeks
Sponsored by: BBOX.io
| -rw-r--r-- | share/man/man4/Makefile | 2 | ||||
| -rw-r--r-- | share/man/man4/ixv.4 | 98 |
2 files changed, 100 insertions, 0 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 40fde6ed7cff..c11110ac447c 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -293,6 +293,7 @@ MAN= aac.4 \ ${_iwx.4} \ ix.4 \ ixl.4 \ + ixv.4 \ jedec_dimm.4 \ jme.4 \ kbdmux.4 \ @@ -774,6 +775,7 @@ MLINKS+=ix.4 if_ix.4 MLINKS+=ix.4 if_ixgbe.4 MLINKS+=ix.4 ixgbe.4 MLINKS+=ixl.4 if_ixl.4 +MLINKS+=ixv.4 if_ixv.4 MLINKS+=iavf.4 if_iavf.4 MLINKS+=jme.4 if_jme.4 MLINKS+=kue.4 if_kue.4 diff --git a/share/man/man4/ixv.4 b/share/man/man4/ixv.4 new file mode 100644 index 000000000000..6acc41737294 --- /dev/null +++ b/share/man/man4/ixv.4 @@ -0,0 +1,98 @@ +.\"- +.\" SPDX-License-Identifier: BSD-3-Clause +.\" +.\" Copyright (c) 2026 Kevin Bowling <kbowling@FreeBSD.org> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of the copyright holder nor the names of its +.\" contributors may be used to endorse or promote products derived from +.\" this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +.\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +.\" TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR +.\" PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +.\" LIABILITY, WHETHER IN 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 POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd August 15, 2026 +.Dt IXV 4 +.Os +.Sh NAME +.Nm ixv +.Nd Intel Ethernet virtual function driver +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in the kernel configuration file: +.Bd -ragged -offset indent +.Cd "device iflib" +.Cd "device ixv" +.Ed +.Pp +Alternatively, to load the driver as a module at boot time, +place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +if_ixv_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver provides support for PCI Express virtual functions exposed by +supported Intel Ethernet controllers. +The physical function must create and configure the virtual function before +it can be attached on the host or assigned to a +.Fx +guest. +.Pp +The driver supports jumbo frames, MSI-X, receive-side scaling, +TCP segmentation offload, checksum offload, and VLAN hardware offload. +The maximum supported MTU is 9710 bytes. +.Pp +The physical-function driver controls the resources and policy presented to +the virtual function. +The number of available queue pairs is negotiated with the physical function +where the mailbox protocol supports it, and is also limited by the available +MSI-X vectors. +Requests to change the MAC address, VLAN membership, or receive mode may be +rejected by physical-function policy. +.Pp +The virtual function cannot configure the physical media. +Only automatic media selection is supported, and reported link state and +speed are supplied by the physical function or virtual-function hardware. +.Sh HARDWARE +The +.Nm +driver supports virtual functions from the following Intel controller +families: +.Pp +.Bl -bullet -compact +.It +Ethernet E610 +.It +Ethernet X550, X552, and X553 +.It +Ethernet X540 +.It +Ethernet 82599 +.El +.Sh SEE ALSO +.Xr iflib 4 , +.Xr ix 4 , +.Xr pci 4 , +.Xr iovctl.conf 5 , +.Xr loader.conf 5 , +.Xr ifconfig 8 |
