1 /*-
2 * Copyright 1998 Massachusetts Institute of Technology
3 *
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
14 * warranty.
15 *
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
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: stable/12/sys/net/if_vlan_var.h 370264 2021-08-02 15:06:16Z kp $
30 */
31
32 #ifndef _NET_IF_VLAN_VAR_H_
33 #define _NET_IF_VLAN_VAR_H_ 1
34
35 #include <sys/mbuf.h>
36
37 /* Set the VLAN ID in an mbuf packet header non-destructively. */
38 #define EVL_APPLY_VLID(m, vlid) \
39 do { \
40 if ((m)->m_flags & M_VLANTAG) { \
41 (m)->m_pkthdr.ether_vtag &= EVL_VLID_MASK; \
42 (m)->m_pkthdr.ether_vtag |= (vlid); \
43 } else { \
44 (m)->m_pkthdr.ether_vtag = (vlid); \
45 (m)->m_flags |= M_VLANTAG; \
46 } \
47 } while (0)
48
49 /* Set the priority ID in an mbuf packet header non-destructively. */
50 #define EVL_APPLY_PRI(m, pri) \
51 do { \
52 if ((m)->m_flags & M_VLANTAG) { \
53 uint16_t __vlantag = (m)->m_pkthdr.ether_vtag; \
54 (m)->m_pkthdr.ether_vtag |= EVL_MAKETAG( \
55 EVL_VLANOFTAG(__vlantag), (pri), \
56 EVL_CFIOFTAG(__vlantag)); \
57 } else { \
58 (m)->m_pkthdr.ether_vtag = \
59 EVL_MAKETAG(0, (pri), 0); \
60 (m)->m_flags |= M_VLANTAG; \
61 } \
62 } while (0)
63
64 /* sysctl(3) tags, for compatibility purposes */
65 #define VLANCTL_PROTO 1
66 #define VLANCTL_MAX 2
67
68 /*
69 * Configuration structure for SIOCSETVLAN and SIOCGETVLAN ioctls.
70 */
71 struct vlanreq {
72 char vlr_parent[IFNAMSIZ];
73 u_short vlr_tag;
74 };
75 #define SIOCSETVLAN SIOCSIFGENERIC
76 #define SIOCGETVLAN SIOCGIFGENERIC
77
78 #define SIOCGVLANPCP SIOCGLANPCP /* Get VLAN PCP */
79 #define SIOCSVLANPCP SIOCSLANPCP /* Set VLAN PCP */
80
81 #ifdef _KERNEL
82 /*
83 * Drivers that are capable of adding and removing the VLAN header
84 * in hardware indicate they support this by marking IFCAP_VLAN_HWTAGGING
85 * in if_capabilities. Drivers for hardware that is capable
86 * of handling larger MTU's that may include a software-appended
87 * VLAN header w/o lowering the normal MTU should mark IFCAP_VLAN_MTU
88 * in if_capabilities; this notifies the VLAN code it can leave the
89 * MTU on the vlan interface at the normal setting.
90 */
91
92 /*
93 * VLAN tags are stored in host byte order. Byte swapping may be
94 * necessary.
95 *
96 * Drivers that support hardware VLAN tag stripping fill in the
97 * received VLAN tag (containing both vlan and priority information)
98 * into the ether_vtag mbuf packet header field:
99 *
100 * m->m_pkthdr.ether_vtag = vtag; // ntohs()?
101 * m->m_flags |= M_VLANTAG;
102 *
103 * to mark the packet m with the specified VLAN tag.
104 *
105 * On output the driver should check the mbuf for the M_VLANTAG
106 * flag to see if a VLAN tag is present and valid:
107 *
108 * if (m->m_flags & M_VLANTAG) {
109 * ... = m->m_pkthdr.ether_vtag; // htons()?
110 * ... pass tag to hardware ...
111 * }
112 *
113 * Note that a driver must indicate it supports hardware VLAN
114 * stripping/insertion by marking IFCAP_VLAN_HWTAGGING in
115 * if_capabilities.
116 */
117
118 /*
119 * The 802.1q code may also tag mbufs with the PCP (priority) field for use in
120 * other layers of the stack, in which case an m_tag will be used. This is
121 * semantically quite different from use of the ether_vtag field, which is
122 * defined only between the device driver and VLAN layer.
123 */
124 #define MTAG_8021Q 1326104895
125 #define MTAG_8021Q_PCP_IN 0 /* Input priority. */
126 #define MTAG_8021Q_PCP_OUT 1 /* Output priority. */
127
128 #define VLAN_PCP_MAX 7
129
130 #define VLAN_CAPABILITIES(_ifp) do { \
131 if ((_ifp)->if_vlantrunk != NULL) \
132 (*vlan_trunk_cap_p)(_ifp); \
133 } while (0)
134
135 #define VLAN_TRUNKDEV(_ifp) \
136 ((_ifp)->if_type == IFT_L2VLAN ? (*vlan_trunkdev_p)((_ifp)) : NULL)
137 #define VLAN_TAG(_ifp, _vid) \
138 ((_ifp)->if_type == IFT_L2VLAN ? (*vlan_tag_p)((_ifp), (_vid)) : EINVAL)
139 #define VLAN_PCP(_ifp, _pcp) \
140 ((_ifp)->if_type == IFT_L2VLAN ? (*vlan_pcp_p)((_ifp), (_pcp)) : EINVAL)
141 #define VLAN_COOKIE(_ifp) \
142 ((_ifp)->if_type == IFT_L2VLAN ? (*vlan_cookie_p)((_ifp)) : NULL)
143 #define VLAN_SETCOOKIE(_ifp, _cookie) \
144 ((_ifp)->if_type == IFT_L2VLAN ? \
145 (*vlan_setcookie_p)((_ifp), (_cookie)) : EINVAL)
146 #define VLAN_DEVAT(_ifp, _vid) \
147 ((_ifp)->if_vlantrunk != NULL ? (*vlan_devat_p)((_ifp), (_vid)) : NULL)
148
149 extern void (*vlan_trunk_cap_p)(struct ifnet *);
150 extern struct ifnet *(*vlan_trunkdev_p)(struct ifnet *);
151 extern struct ifnet *(*vlan_devat_p)(struct ifnet *, uint16_t);
152 extern int (*vlan_tag_p)(struct ifnet *, uint16_t *);
153 extern int (*vlan_pcp_p)(struct ifnet *, uint16_t *);
154 extern int (*vlan_setcookie_p)(struct ifnet *, void *);
155 extern void *(*vlan_cookie_p)(struct ifnet *);
156
157 #ifdef _SYS_EVENTHANDLER_H_
158 /* VLAN state change events */
159 typedef void (*vlan_config_fn)(void *, struct ifnet *, uint16_t);
160 typedef void (*vlan_unconfig_fn)(void *, struct ifnet *, uint16_t);
161 EVENTHANDLER_DECLARE(vlan_config, vlan_config_fn);
162 EVENTHANDLER_DECLARE(vlan_unconfig, vlan_unconfig_fn);
163 #endif /* _SYS_EVENTHANDLER_H_ */
164
165 static inline int
vlan_set_pcp(struct mbuf * m,uint8_t prio)166 vlan_set_pcp(struct mbuf *m, uint8_t prio)
167 {
168 struct m_tag *mtag;
169
170 KASSERT(prio <= VLAN_PCP_MAX,
171 ("%s with invalid pcp", __func__));
172
173 mtag = m_tag_locate(m, MTAG_8021Q, MTAG_8021Q_PCP_OUT, NULL);
174 if (mtag == NULL) {
175 mtag = m_tag_alloc(MTAG_8021Q, MTAG_8021Q_PCP_OUT,
176 sizeof(uint8_t), M_NOWAIT);
177 if (mtag == NULL)
178 return (ENOMEM);
179 m_tag_prepend(m, mtag);
180 }
181
182 *(uint8_t *)(mtag + 1) = prio;
183
184 return (0);
185 }
186
187 #endif /* _KERNEL */
188
189 #endif /* _NET_IF_VLAN_VAR_H_ */
190