xref: /netbsd-src/share/man/man4/ixv.4 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.\"	$NetBSD: ixv.4,v 1.7 2021/03/09 12:02:24 wiz Exp $
2.\"
3.\" Copyright (c) 2018 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Masanobu SAITOH.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd March 9, 2021
31.Dt IXV 4
32.Os
33.Sh NAME
34.Nm ixv
35.Nd Intel 10 Gigabit Ethernet virtual function
36.Sh SYNOPSIS
37.Cd "ixv* at pci? dev ? function ?"
38.Sh DESCRIPTION
39The
40.Nm
41driver supports Intel 10 Gigabit Ethernet virtual function that 82599 and
42newer chips support.
43It can be used on a
44.Nx
45guest that the host supports SR-IOV.
46.Sh OPTIONS
47The
48.Nm
49driver doesn't use the common
50.Xr MCLGET 9
51interface and use the driver specific cluster allocation mechanism.
52If it's exhausted, the
53.Xr evcnt 9
54counter "ixgX qY Rx no jumbo mbuf" is incremented.
55If this is observed,
56the number can be changed by the following config parameter:
57.Bl -tag -width IXGBE_JCLNUM_MULTI -offset 3n
58.It Dv IXGBE_JCLNUM_MULTI
59The number of RX jumbo buffers (clusters) per queue is calculated by
60.Dv IXGBE_JCLNUM_MULTI
61* (number of rx descriptors).
62The total number of clusters per queue is available with the
63.Li hw.ixgN.num_jcl_per_queue
64.Xr sysctl 7 .
65.El
66.Sh SEE ALSO
67.Xr arp 4 ,
68.Xr ixg 4 ,
69.Xr netintro 4 ,
70.Xr vlan 4 ,
71.Xr ifconfig 8
72.Sh HISTORY
73The
74.Nm
75device driver comes from
76.Fx .
77It first appeared in
78.Nx 8.0 .
79.Sh AUTHORS
80The
81.Nm
82driver was written by
83.An Intel Corporation Aq Mt freebsdnic@mailbox.intel.com .
84.Sh BUGS
85The following event counters are not cleared by
86.Dv SIOCZIFDATA
87because the corresponding registers are read only and not cleared on read:
88.Pp
89.Bl -item -offset indent -compact
90.It
91Good Packets Received
92.It
93Good Octets Received
94.It
95Multicast Packets Received
96.It
97Good Packets Transmitted
98.It
99Good Octets Transmitted
100.El
101