2 * Copyright 1998 Massachusetts Institute of Technology
4 * Permission to use, copy, modify, and distribute this software and
5 * its documentation for any purpose and without fee is hereby
6 * granted, provided that both the above copyright notice and this
7 * permission notice appear in all copies, that both the above
8 * copyright notice and this permission notice appear in all
9 * supporting documentation, and that the name of M.I.T. not be used
10 * in advertising or publicity pertaining to distribution of the
11 * software without specific, written prior permission. M.I.T. makes
12 * no representations about the suitability of this software for any
13 * purpose. It is provided "as is" without express or implied
16 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS
17 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
20 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
26 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #ifndef _NET_IF_VLAN_VAR_H_
33 #define _NET_IF_VLAN_VAR_H_ 1
35 /* Set the VLAN ID in an mbuf packet header non-destructively. */
36 #define EVL_APPLY_VLID(m, vlid) \
38 if ((m)->m_flags & M_VLANTAG) { \
39 (m)->m_pkthdr.ether_vtag &= EVL_VLID_MASK; \
40 (m)->m_pkthdr.ether_vtag |= (vlid); \
42 (m)->m_pkthdr.ether_vtag = (vlid); \
43 (m)->m_flags |= M_VLANTAG; \
47 /* Set the priority ID in an mbuf packet header non-destructively. */
48 #define EVL_APPLY_PRI(m, pri) \
50 if ((m)->m_flags & M_VLANTAG) { \
51 uint16_t __vlantag = (m)->m_pkthdr.ether_vtag; \
52 (m)->m_pkthdr.ether_vtag |= EVL_MAKETAG( \
53 EVL_VLANOFTAG(__vlantag), (pri), \
54 EVL_CFIOFTAG(__vlantag)); \
56 (m)->m_pkthdr.ether_vtag = \
57 EVL_MAKETAG(0, (pri), 0); \
58 (m)->m_flags |= M_VLANTAG; \
62 /* sysctl(3) tags, for compatibility purposes */
63 #define VLANCTL_PROTO 1
67 * Configuration structure for SIOCSETVLAN and SIOCGETVLAN ioctls.
70 char vlr_parent[IFNAMSIZ];
73 #define SIOCSETVLAN SIOCSIFGENERIC
74 #define SIOCGETVLAN SIOCGIFGENERIC
76 #define SIOCGVLANPCP _IOWR('i', 152, struct ifreq) /* Get VLAN PCP */
77 #define SIOCSVLANPCP _IOW('i', 153, struct ifreq) /* Set VLAN PCP */
80 * Names for 802.1q priorities ("802.1p"). Notice that in this scheme,
81 * (0 < 1), allowing default 0-tagged traffic to take priority over background
84 #define IEEE8021Q_PCP_BK 1 /* Background (lowest) */
85 #define IEEE8021Q_PCP_BE 0 /* Best effort (default) */
86 #define IEEE8021Q_PCP_EE 2 /* Excellent effort */
87 #define IEEE8021Q_PCP_CA 3 /* Critical applications */
88 #define IEEE8021Q_PCP_VI 4 /* Video, < 100ms latency */
89 #define IEEE8021Q_PCP_VO 5 /* Video, < 10ms latency */
90 #define IEEE8021Q_PCP_IC 6 /* Internetwork control */
91 #define IEEE8021Q_PCP_NC 7 /* Network control (highest) */
95 * Drivers that are capable of adding and removing the VLAN header
96 * in hardware indicate they support this by marking IFCAP_VLAN_HWTAGGING
97 * in if_capabilities. Drivers for hardware that is capable
98 * of handling larger MTU's that may include a software-appended
99 * VLAN header w/o lowering the normal MTU should mark IFCAP_VLAN_MTU
100 * in if_capabilities; this notifies the VLAN code it can leave the
101 * MTU on the vlan interface at the normal setting.
105 * VLAN tags are stored in host byte order. Byte swapping may be
108 * Drivers that support hardware VLAN tag stripping fill in the
109 * received VLAN tag (containing both vlan and priority information)
110 * into the ether_vtag mbuf packet header field:
112 * m->m_pkthdr.ether_vtag = vtag; // ntohs()?
113 * m->m_flags |= M_VLANTAG;
115 * to mark the packet m with the specified VLAN tag.
117 * On output the driver should check the mbuf for the M_VLANTAG
118 * flag to see if a VLAN tag is present and valid:
120 * if (m->m_flags & M_VLANTAG) {
121 * ... = m->m_pkthdr.ether_vtag; // htons()?
122 * ... pass tag to hardware ...
125 * Note that a driver must indicate it supports hardware VLAN
126 * stripping/insertion by marking IFCAP_VLAN_HWTAGGING in
131 * The 802.1q code may also tag mbufs with the PCP (priority) field for use in
132 * other layers of the stack, in which case an m_tag will be used. This is
133 * semantically quite different from use of the ether_vtag field, which is
134 * defined only between the device driver and VLAN layer.
136 #define MTAG_8021Q 1326104895
137 #define MTAG_8021Q_PCP_IN 0 /* Input priority. */
138 #define MTAG_8021Q_PCP_OUT 1 /* Output priority. */
140 #define VLAN_CAPABILITIES(_ifp) do { \
141 if ((_ifp)->if_vlantrunk != NULL) \
142 (*vlan_trunk_cap_p)(_ifp); \
145 #define VLAN_TRUNKDEV(_ifp) \
146 (_ifp)->if_type == IFT_L2VLAN ? (*vlan_trunkdev_p)((_ifp)) : NULL
147 #define VLAN_TAG(_ifp, _vid) \
148 (_ifp)->if_type == IFT_L2VLAN ? (*vlan_tag_p)((_ifp), (_vid)) : EINVAL
149 #define VLAN_COOKIE(_ifp) \
150 (_ifp)->if_type == IFT_L2VLAN ? (*vlan_cookie_p)((_ifp)) : NULL
151 #define VLAN_SETCOOKIE(_ifp, _cookie) \
152 (_ifp)->if_type == IFT_L2VLAN ? \
153 (*vlan_setcookie_p)((_ifp), (_cookie)) : EINVAL
154 #define VLAN_DEVAT(_ifp, _vid) \
155 (_ifp)->if_vlantrunk != NULL ? (*vlan_devat_p)((_ifp), (_vid)) : NULL
157 extern void (*vlan_trunk_cap_p)(struct ifnet *);
158 extern struct ifnet *(*vlan_trunkdev_p)(struct ifnet *);
159 extern struct ifnet *(*vlan_devat_p)(struct ifnet *, uint16_t);
160 extern int (*vlan_tag_p)(struct ifnet *, uint16_t *);
161 extern int (*vlan_setcookie_p)(struct ifnet *, void *);
162 extern void *(*vlan_cookie_p)(struct ifnet *);
164 #ifdef _SYS_EVENTHANDLER_H_
165 /* VLAN state change events */
166 typedef void (*vlan_config_fn)(void *, struct ifnet *, uint16_t);
167 typedef void (*vlan_unconfig_fn)(void *, struct ifnet *, uint16_t);
168 EVENTHANDLER_DECLARE(vlan_config, vlan_config_fn);
169 EVENTHANDLER_DECLARE(vlan_unconfig, vlan_unconfig_fn);
170 #endif /* _SYS_EVENTHANDLER_H_ */
174 #endif /* _NET_IF_VLAN_VAR_H_ */