Bunch of mdoc(7) and various file path fixes.
[dragonfly.git] / 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.4 2004/07/08 00:14:49 hmp 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 physical devices that do
75 the VLAN demultiplexing in firmware.
76 The
77 .Cm link0
78 flag should be set on a
79 .Nm
80 interface
81 .Pq Em not on its parent
82 using
83 .Xr ifconfig 8
84 in that case to indicate that hardware support for
85 the 802.1Q VLANs is present in its parent.
86 .\"
87 .Ss "Selecting the Right Network Interface Card to Run VLANs Through"
88 By now, the only NICs that have both hardware support and proper
89 driver hooks for the 802.1Q VLAN technology in
90 .Dx
91 are
92 .Xr bge 4 ,
93 .Xr em 4 ,
94 .Xr gx 4 ,
95 .Xr nge 4 ,
96 .Xr ti 4 ,
97 and
98 .Xr txp 4 .
99 .Pp
100 The rest of the ethernet NICs supported by
101 .Dx
102 can run
103 VLANs using software emulation in the
104 .Nm
105 driver.
106 However, most of them lack the capability
107 of transmitting and/or receiving oversized frames.
108 Using such a NIC as a parent interface
109 implies a reduced MTU on the corresponding
110 .Nm
111 interfaces.
112 In the modern Internet, this is likely to cause
113 .Xr tcp 4
114 connectivity problems due to massive, inadequate
115 .Xr icmp 4
116 filtering that breaks the Path MTU Discovery mechanism.
117 .Pp
118 The NICs that support oversized frames are as follows:
119 .Bl -tag -width ".Xr fxp 4 " -offset indent
120 .It Xr dc 4
121 supports long frames for
122 .Nm
123 natively.
124 .It Xr de 4
125 requires defining
126 .Dv BIG_PACKET
127 in the
128 .Pa /sys/dev/netif/de/if_de.c
129 source file and rebuilding the kernel.
130 The hack works only for the 21041, 21140, and 21140A chips.
131 .It Xr fxp 4
132 supports long frames for
133 .Nm
134 natively.
135 .It Xr sis 4
136 supports long frames for
137 .Nm
138 natively.
139 .It Xr ste 4
140 supports long frames for
141 .Nm
142 natively.
143 .It Xr tl 4
144 has support for long frames.
145 .It Xr tx 4
146 supports long frames for
147 .Nm
148 natively.
149 .It Xr xl 4
150 supports long frames only if the card is built on a newer chip
151 (Cyclone and above).
152 .El
153 .Pp
154 Note:
155 Unless marked as having native support for
156 .Nm ,
157 the above drivers don't inform the
158 .Nm
159 driver about their long frame handling capability.
160 Just increase the MTU of a
161 .Nm
162 interface if it appears to be lower than 1500 bytes after
163 attaching to a parent known to support long frames.
164 .Sh SEE ALSO
165 .Xr ifconfig 8
166 .Sh BUGS
167 No 802.1Q features except VLAN tagging are implemented.