]> git.proxmox.com Git - mirror_ovs.git/blame - utilities/ovs-vlan-bug-workaround.8.in
utilities: gdb debug commands fix typos
[mirror_ovs.git] / utilities / ovs-vlan-bug-workaround.8.in
CommitLineData
431488e6 1.\" -*- nroff -*-
9bccc3ff 2.so lib/ovs.tmac
d2cb6c95 3.TH ovs\-vlan\-bug\-workaround 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
431488e6
BP
4.ds PN ovs\-vlan\-bug\-workaround
5.
6.SH NAME
7ovs\-vlan\-bug\-workaround \- utility for configuring Linux VLAN driver bug workaround
8.
9.SH SYNOPSIS
10\fBovs\-vlan\-bug\-workaround \fInetdev\fR \fBon\fR
11.br
12\fBovs\-vlan\-bug\-workaround \fInetdev\fR \fBoff\fR
13.br
14\fBovs\-vlan\-bug\-workaround \-\-help
15.br
16\fBovs\-vlan\-bug\-workaround \-\-version
17.SH DESCRIPTION
18.
19.PP
20Some Linux network drivers support a feature called ``VLAN
21acceleration''. VLAN acceleration is associated with a data structure
22called a \fBvlan_group\fR that is, abstractly, a dictionary that maps
23from a VLAN ID (in the range 0 to 4095) to a VLAN device, that is, a
24Linux network device associated with a particular VLAN,
25e.g. \fBeth0.9\fR for VLAN 9 on \fBeth0\fR.
26.PP
27Some drivers that support VLAN acceleration have bugs that fall
28roughly into the categories listed below. \fBovs\-vlan\-test\fR(8)
29can test for these driver bugs.
30.so utilities/ovs-vlan-bugs.man
31.PP
32.PP
33The correct long term solution is to fix these driver bugs.
34.PP
35For now, \fBovs\-vlan\-bug\-workaround\fR can enable a special-purpose
36workaround for devices with buggy VLAN acceleration. A kernel patch
37must be applied for this workaround to work.
38.PP
39Use the command \fBovs\-vlan\-bug\-workaround \fInetdev\fR \fBon\fR to
40enable the VLAN driver bug workaround for network device \fInetdev\fR.
41Use the command \fBovs\-vlan\-bug\-workaround \fInetdev\fR \fBoff\fR to
42disable the VLAN driver bug workaround for network device \fInetdev\fR.
43.SH "DRIVER DETAILS"
44.PP
45The following drivers in Linux version
462.6.32.12-0.7.1.xs1.0.0.311.170586 implement VLAN acceleration and are
47relevant to Open vSwitch on XenServer. We have not tested any version
48of most of these drivers, so we do not know whether they have a VLAN
49problem that needs to be fixed. The drivers are listed by the name
50that they report in, e.g., \fBethtool \-i\fR output; in a few cases
51this differs slightly from the name of the module's \fB.ko\fR file:
52.
53.nf
54.ta T 1i
55\fB8139cp acenic amd8111e atl1c ATL1E atl1
56atl2 be2net bna bnx2 bnx2x cnic
57cxgb cxgb3 e1000 e1000e enic forcedeth
58igb igbvf ixgb ixgbe jme ml4x_core
59ns83820 qlge r8169 S2IO sky2 starfire
60tehuti tg3 typhoon via-velocity vxge
61.fi
62.PP
63The following drivers use \fBvlan_group\fR but are irrelevant to Open
64vSwitch on XenServer:
65.IP "\fBbonding\fR"
66Not used with Open vSwitch on XenServer.
67.IP "\fBgianfar\fR"
68Not shipped with XenServer. A FreeScale CPU-integrated device.
69.IP "\fBehea\fR"
70Cannot be built on x86. IBM Power architecture only.
71.IP "\fBstmmac\fR"
72Cannot be built on x86. SH4 architecture only.
73.IP "\fBvmxnet3\fR"
74Not shipped with XenServer. For use inside VMware VMs only.
75.
76.SH OPTIONS
77.
78.so lib/common.man
79.
80.SH BUGS
81.
82Obviously.
83.
84.SH "SEE ALSO"
85.
86.BR ovs\-vlan\-test (8).