share/man/man4/vlan.4

   1 .\"
   2 .\" Copyright (c) 2001 Yar Tikhiy
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man4/vlan.4,v 1.1.2.6 2002/08/30 11:53:56 yar Exp $
  27 .\" $DragonFly: src/share/man/man4/vlan.4,v 1.13 2008/07/27 12:02:51 swildner Exp $
  28 .\"
  29 .Dd July 25, 2001
  30 .Dt VLAN 4
  31 .Os
  32 .Sh NAME
  33 .Nm vlan
  34 .Nd IEEE 802.1Q VLAN network interface
  35 .Sh SYNOPSIS
  36 .Cd pseudo-device vlan Op Ar count
  37 .\"
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver demultiplexes frames tagged according to
  42 the IEEE 802.1Q standard into logical
  43 .Nm
  44 network interfaces, which allows routing/bridging between
  45 multiple VLANs through a single switch trunk port.
  46 .Pp
  47 Each
  48 .Nm
  49 interface is created at runtime using interface cloning.
  50 This is
  51 most easily done with the
  52 .Xr ifconfig 8
  53 .Cm create
  54 command or using the
  55 .Va cloned_interfaces
  56 variable in
  57 .Xr rc.conf 5 .
  58 .Pp
  59 To function, a
  60 .Nm
  61 interface must be assigned a parent interface and
  62 numeric VLAN tag using
  63 .Xr ifconfig 8 .
  64 A single parent can be assigned to multiple
  65 .Nm
  66 interfaces provided they have different tags.
  67 The parent interface is likely to be an ethernet card connected
  68 to a properly configured switch port.
  69 The VLAN tag should match one of those set up in the switched
  70 network.
  71 .Pp
  72 The
  73 .Nm
  74 driver supports efficient operation over parent interfaces that can provide
  75 help in processing VLANs.
  76 Such interfaces are automatically recognized by their capabilities.
  77 Depending on the level of sophistication found in a physical
  78 interface, it may do full VLAN processing or just be able to
  79 receive and transmit frames exceeding the maximum Ethernet frame size
  80 by the length of a 802.1Q header.
  81 The capabilities may be user-controlled by the respective parameters to
  82 .Xr ifconfig 8 ,
  83 .Cm vlanhwtag
  84 and
  85 .Cm vlanmtu .
  86 However, a physical interface is not obliged to react to them:
  87 It may have either capability enabled permanently without
  88 a way to turn it off.
  89 The whole issue is very specific to a particular device and its driver.
  90 .\"
  91 .Ss "Selecting the Right Network Interface Card to Run VLANs Through"
  92 By now, the only NICs that have both hardware support and proper
  93 driver hooks for the 802.1Q VLAN technology in
  94 .Dx
  95 are
  96 .Xr bce 4 ,
  97 .Xr bge 4 ,
  98 .Xr em 4 ,
  99 .Xr jme 4 ,
 100 .\".Xr msk 4 ,
 101 .Xr nfe 4 ,
 102 .Xr nge 4 ,
 103 .Xr re 4 ,
 104 .Xr stge 4 ,
 105 .Xr ti 4 ,
 106 .Xr txp 4 ,
 107 and
 108 .Xr vge 4 .
 109 .Pp
 110 The rest of the ethernet NICs supported by
 111 .Dx
 112 can run
 113 VLANs using software emulation in the
 114 .Nm
 115 driver.
 116 However, most of them lack the capability
 117 of transmitting and/or receiving oversized frames.
 118 Using such a NIC as a parent interface
 119 implies a reduced MTU on the corresponding
 120 .Nm
 121 interfaces.
 122 In the modern Internet, this is likely to cause
 123 .Xr tcp 4
 124 connectivity problems due to massive, inadequate
 125 .Xr icmp 4
 126 filtering that breaks the Path MTU Discovery mechanism.
 127 .Pp
 128 The NICs that support oversized frames are as follows:
 129 .Bl -tag -width ".Xr fxp 4 " -offset indent
 130 .It Xr dc 4
 131 supports long frames for
 132 .Nm
 133 natively.
 134 .It Xr de 4
 135 requires defining
 136 .Dv BIG_PACKET
 137 in the
 138 .Pa /sys/dev/netif/de/if_de.c
 139 source file and rebuilding the kernel.
 140 The hack works only for the 21041, 21140, and 21140A chips.
 141 .It Xr et 4
 142 supports long frames for
 143 .Nm
 144 natively.
 145 .It Xr fxp 4
 146 supports long frames for
 147 .Nm
 148 natively.
 149 .It Xr sis 4
 150 supports long frames for
 151 .Nm
 152 natively.
 153 .It Xr ste 4
 154 supports long frames for
 155 .Nm
 156 natively.
 157 .It Xr tl 4
 158 has support for long frames.
 159 .It Xr tx 4
 160 supports long frames for
 161 .Nm
 162 natively.
 163 .It Xr xl 4
 164 supports long frames only if the card is built on a newer chip
 165 (Cyclone and above).
 166 .El
 167 .Pp
 168 Note:
 169 Unless marked as having native support for
 170 .Nm ,
 171 the above drivers don't inform the
 172 .Nm
 173 driver about their long frame handling capability.
 174 Just increase the MTU of a
 175 .Nm
 176 interface if it appears to be lower than 1500 bytes after
 177 attaching to a parent known to support long frames.
 178 .Sh SEE ALSO
 179 .Xr ifconfig 8
 180 .Sh BUGS
 181 No 802.1Q features except VLAN tagging are implemented.