utilities/ovs-vlan-bug-workaround.8.in

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