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 SIOCGLANPCP /* Get VLAN PCP */
77 #define SIOCSVLANPCP SIOCSLANPCP /* Set VLAN PCP */
81 * Drivers that are capable of adding and removing the VLAN header
82 * in hardware indicate they support this by marking IFCAP_VLAN_HWTAGGING
83 * in if_capabilities. Drivers for hardware that is capable
84 * of handling larger MTU's that may include a software-appended
85 * VLAN header w/o lowering the normal MTU should mark IFCAP_VLAN_MTU
86 * in if_capabilities; this notifies the VLAN code it can leave the
87 * MTU on the vlan interface at the normal setting.
91 * VLAN tags are stored in host byte order. Byte swapping may be
94 * Drivers that support hardware VLAN tag stripping fill in the
95 * received VLAN tag (containing both vlan and priority information)
96 * into the ether_vtag mbuf packet header field:
98 * m->m_pkthdr.ether_vtag = vtag; // ntohs()?
99 * m->m_flags |= M_VLANTAG;
101 * to mark the packet m with the specified VLAN tag.
103 * On output the driver should check the mbuf for the M_VLANTAG
104 * flag to see if a VLAN tag is present and valid:
106 * if (m->m_flags & M_VLANTAG) {
107 * ... = m->m_pkthdr.ether_vtag; // htons()?
108 * ... pass tag to hardware ...
111 * Note that a driver must indicate it supports hardware VLAN
112 * stripping/insertion by marking IFCAP_VLAN_HWTAGGING in
117 * The 802.1q code may also tag mbufs with the PCP (priority) field for use in
118 * other layers of the stack, in which case an m_tag will be used. This is
119 * semantically quite different from use of the ether_vtag field, which is
120 * defined only between the device driver and VLAN layer.
122 #define MTAG_8021Q 1326104895
123 #define MTAG_8021Q_PCP_IN 0 /* Input priority. */
124 #define MTAG_8021Q_PCP_OUT 1 /* Output priority. */
126 #define VLAN_CAPABILITIES(_ifp) do { \
127 if ((_ifp)->if_vlantrunk != NULL) \
128 (*vlan_trunk_cap_p)(_ifp); \
131 #define VLAN_TRUNKDEV(_ifp) \
132 ((_ifp)->if_type == IFT_L2VLAN ? (*vlan_trunkdev_p)((_ifp)) : NULL)
133 #define VLAN_TAG(_ifp, _vid) \
134 ((_ifp)->if_type == IFT_L2VLAN ? (*vlan_tag_p)((_ifp), (_vid)) : EINVAL)
135 #define VLAN_PCP(_ifp, _pcp) \
136 ((_ifp)->if_type == IFT_L2VLAN ? (*vlan_pcp_p)((_ifp), (_pcp)) : EINVAL)
137 #define VLAN_COOKIE(_ifp) \
138 ((_ifp)->if_type == IFT_L2VLAN ? (*vlan_cookie_p)((_ifp)) : NULL)
139 #define VLAN_SETCOOKIE(_ifp, _cookie) \
140 ((_ifp)->if_type == IFT_L2VLAN ? \
141 (*vlan_setcookie_p)((_ifp), (_cookie)) : EINVAL)
142 #define VLAN_DEVAT(_ifp, _vid) \
143 ((_ifp)->if_vlantrunk != NULL ? (*vlan_devat_p)((_ifp), (_vid)) : NULL)
145 extern void (*vlan_trunk_cap_p)(struct ifnet *);
146 extern struct ifnet *(*vlan_trunkdev_p)(struct ifnet *);
147 extern struct ifnet *(*vlan_devat_p)(struct ifnet *, uint16_t);
148 extern int (*vlan_tag_p)(struct ifnet *, uint16_t *);
149 extern int (*vlan_pcp_p)(struct ifnet *, uint16_t *);
150 extern int (*vlan_setcookie_p)(struct ifnet *, void *);
151 extern void *(*vlan_cookie_p)(struct ifnet *);
153 #include <sys/_eventhandler.h>
155 /* VLAN state change events */
156 typedef void (*vlan_config_fn)(void *, struct ifnet *, uint16_t);
157 typedef void (*vlan_unconfig_fn)(void *, struct ifnet *, uint16_t);
158 EVENTHANDLER_DECLARE(vlan_config, vlan_config_fn);
159 EVENTHANDLER_DECLARE(vlan_unconfig, vlan_unconfig_fn);
163 #endif /* _NET_IF_VLAN_VAR_H_ */