]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/if_vlan.h
net: vlan: add protocol argument to packet tagging functions
[mirror_ubuntu-bionic-kernel.git] / include / linux / if_vlan.h
CommitLineData
1da177e4
LT
1/*
2 * VLAN An implementation of 802.1Q VLAN tagging.
3 *
4 * Authors: Ben Greear <greearb@candelatech.com>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
10 *
11 */
1da177e4
LT
12#ifndef _LINUX_IF_VLAN_H_
13#define _LINUX_IF_VLAN_H_
14
1da177e4 15#include <linux/netdevice.h>
0610d11b 16#include <linux/etherdevice.h>
65ac6a5f 17#include <linux/rtnetlink.h>
187f1882 18#include <linux/bug.h>
607ca46e 19#include <uapi/linux/if_vlan.h>
1da177e4 20
a3f671b3
JP
21#define VLAN_HLEN 4 /* The additional bytes required by VLAN
22 * (in addition to the Ethernet header)
1da177e4 23 */
1da177e4
LT
24#define VLAN_ETH_HLEN 18 /* Total octets in header. */
25#define VLAN_ETH_ZLEN 64 /* Min. octets in frame sans FCS */
26
27/*
28 * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
29 */
30#define VLAN_ETH_DATA_LEN 1500 /* Max. octets in payload */
31#define VLAN_ETH_FRAME_LEN 1518 /* Max. octets in frame sans FCS */
32
740c15d0
PM
33/*
34 * struct vlan_hdr - vlan header
35 * @h_vlan_TCI: priority and VLAN ID
36 * @h_vlan_encapsulated_proto: packet type ID or len
37 */
38struct vlan_hdr {
39 __be16 h_vlan_TCI;
40 __be16 h_vlan_encapsulated_proto;
41};
42
43/**
44 * struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
45 * @h_dest: destination ethernet address
46 * @h_source: source ethernet address
47 * @h_vlan_proto: ethernet protocol (always 0x8100)
48 * @h_vlan_TCI: priority and VLAN ID
49 * @h_vlan_encapsulated_proto: packet type ID or len
50 */
1da177e4 51struct vlan_ethhdr {
740c15d0
PM
52 unsigned char h_dest[ETH_ALEN];
53 unsigned char h_source[ETH_ALEN];
54 __be16 h_vlan_proto;
55 __be16 h_vlan_TCI;
56 __be16 h_vlan_encapsulated_proto;
1da177e4
LT
57};
58
59#include <linux/skbuff.h>
60
61static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
62{
98e399f8 63 return (struct vlan_ethhdr *)skb_mac_header(skb);
1da177e4
LT
64}
65
05423b24
ED
66#define VLAN_PRIO_MASK 0xe000 /* Priority Code Point */
67#define VLAN_PRIO_SHIFT 13
68#define VLAN_CFI_MASK 0x1000 /* Canonical Format Indicator */
69#define VLAN_TAG_PRESENT VLAN_CFI_MASK
70#define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
b738127d 71#define VLAN_N_VID 4096
1da177e4
LT
72
73/* found in socket.c */
881d966b 74extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
1da177e4 75
6dcbbe25
NH
76static inline int is_vlan_dev(struct net_device *dev)
77{
78 return dev->priv_flags & IFF_802_1Q_VLAN;
79}
80
05423b24 81#define vlan_tx_tag_present(__skb) ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
48cc32d3
FZ
82#define vlan_tx_nonzero_tag_present(__skb) \
83 (vlan_tx_tag_present(__skb) && ((__skb)->vlan_tci & VLAN_VID_MASK))
05423b24 84#define vlan_tx_tag_get(__skb) ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
1da177e4 85
7750f403 86#if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
65ac6a5f 87
cec9c133 88extern struct net_device *__vlan_find_dev_deep(struct net_device *real_dev,
1fd9b1fc 89 __be16 vlan_proto, u16 vlan_id);
22d1ba74
PM
90extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
91extern u16 vlan_dev_vlan_id(const struct net_device *dev);
92
48cc32d3 93extern bool vlan_do_receive(struct sk_buff **skb);
bcc6d479 94extern struct sk_buff *vlan_untag(struct sk_buff *skb);
9b22ea56 95
80d5c368
PM
96extern int vlan_vid_add(struct net_device *dev, __be16 proto, u16 vid);
97extern void vlan_vid_del(struct net_device *dev, __be16 proto, u16 vid);
87002b03 98
348a1443
JP
99extern int vlan_vids_add_by_dev(struct net_device *dev,
100 const struct net_device *by_dev);
101extern void vlan_vids_del_by_dev(struct net_device *dev,
102 const struct net_device *by_dev);
9b361c13
JP
103
104extern bool vlan_uses_dev(const struct net_device *dev);
7750f403 105#else
cec9c133
JP
106static inline struct net_device *
107__vlan_find_dev_deep(struct net_device *real_dev, u16 vlan_id)
108{
109 return NULL;
110}
111
22d1ba74
PM
112static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
113{
114 BUG();
115 return NULL;
116}
117
118static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
119{
120 BUG();
121 return 0;
122}
123
48cc32d3 124static inline bool vlan_do_receive(struct sk_buff **skb)
9b22ea56 125{
3701e513 126 return false;
9b22ea56 127}
e1c096e2 128
6139e75f 129static inline struct sk_buff *vlan_untag(struct sk_buff *skb)
bcc6d479
JP
130{
131 return skb;
132}
87002b03
JP
133
134static inline int vlan_vid_add(struct net_device *dev, unsigned short vid)
135{
136 return 0;
137}
138
139static inline void vlan_vid_del(struct net_device *dev, unsigned short vid)
140{
141}
348a1443
JP
142
143static inline int vlan_vids_add_by_dev(struct net_device *dev,
144 const struct net_device *by_dev)
145{
146 return 0;
147}
148
149static inline void vlan_vids_del_by_dev(struct net_device *dev,
150 const struct net_device *by_dev)
151{
152}
9b361c13
JP
153
154static inline bool vlan_uses_dev(const struct net_device *dev)
155{
156 return false;
157}
7750f403 158#endif
1da177e4 159
86a9bad3
PM
160static inline bool vlan_hw_offload_capable(netdev_features_t features,
161 __be16 proto)
162{
163 if (proto == htons(ETH_P_8021Q) && features & NETIF_F_HW_VLAN_CTAG_TX)
164 return true;
165 return false;
166}
167
1da177e4 168/**
0b5c9db1 169 * vlan_insert_tag - regular VLAN tag inserting
1da177e4 170 * @skb: skbuff to tag
86a9bad3 171 * @vlan_proto: VLAN encapsulation protocol
9bb8582e 172 * @vlan_tci: VLAN TCI to insert
1da177e4
LT
173 *
174 * Inserts the VLAN tag into @skb as part of the payload
175 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
9bb8582e 176 *
1da177e4
LT
177 * Following the skb_unshare() example, in case of error, the calling function
178 * doesn't have to worry about freeing the original skb.
0b5c9db1
JP
179 *
180 * Does not change skb->protocol so this function can be used during receive.
1da177e4 181 */
86a9bad3
PM
182static inline struct sk_buff *vlan_insert_tag(struct sk_buff *skb,
183 __be16 vlan_proto, u16 vlan_tci)
1da177e4
LT
184{
185 struct vlan_ethhdr *veth;
186
11a100f8
PM
187 if (skb_cow_head(skb, VLAN_HLEN) < 0) {
188 kfree_skb(skb);
189 return NULL;
1da177e4 190 }
1da177e4
LT
191 veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
192
193 /* Move the mac addresses to the beginning of the new header. */
a3f671b3 194 memmove(skb->data, skb->data + VLAN_HLEN, 2 * ETH_ALEN);
e4dd6188 195 skb->mac_header -= VLAN_HLEN;
1da177e4
LT
196
197 /* first, the ethernet type */
86a9bad3 198 veth->h_vlan_proto = vlan_proto;
1da177e4 199
9bb8582e
PM
200 /* now, the TCI */
201 veth->h_vlan_TCI = htons(vlan_tci);
1da177e4 202
0b5c9db1
JP
203 return skb;
204}
1da177e4 205
0b5c9db1
JP
206/**
207 * __vlan_put_tag - regular VLAN tag inserting
208 * @skb: skbuff to tag
209 * @vlan_tci: VLAN TCI to insert
210 *
211 * Inserts the VLAN tag into @skb as part of the payload
212 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
213 *
214 * Following the skb_unshare() example, in case of error, the calling function
215 * doesn't have to worry about freeing the original skb.
216 */
86a9bad3
PM
217static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb,
218 __be16 vlan_proto, u16 vlan_tci)
0b5c9db1 219{
86a9bad3 220 skb = vlan_insert_tag(skb, vlan_proto, vlan_tci);
0b5c9db1 221 if (skb)
86a9bad3 222 skb->protocol = vlan_proto;
1da177e4
LT
223 return skb;
224}
225
226/**
227 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
228 * @skb: skbuff to tag
86a9bad3 229 * @vlan_proto: VLAN encapsulation protocol
9bb8582e 230 * @vlan_tci: VLAN TCI to insert
1da177e4 231 *
6aa895b0 232 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
1da177e4 233 */
9bb8582e 234static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
86a9bad3 235 __be16 vlan_proto,
9bb8582e 236 u16 vlan_tci)
1da177e4 237{
86a9bad3 238 skb->vlan_proto = vlan_proto;
05423b24 239 skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
1da177e4
LT
240 return skb;
241}
242
243#define HAVE_VLAN_PUT_TAG
244
245/**
246 * vlan_put_tag - inserts VLAN tag according to device features
247 * @skb: skbuff to tag
9bb8582e 248 * @vlan_tci: VLAN TCI to insert
1da177e4
LT
249 *
250 * Assumes skb->dev is the target that will xmit this frame.
251 * Returns a VLAN tagged skb.
252 */
86a9bad3
PM
253static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb,
254 __be16 vlan_proto, u16 vlan_tci)
1da177e4 255{
86a9bad3
PM
256 if (vlan_hw_offload_capable(skb->dev->features, vlan_proto)) {
257 return __vlan_hwaccel_put_tag(skb, vlan_proto, vlan_tci);
1da177e4 258 } else {
86a9bad3 259 return __vlan_put_tag(skb, vlan_proto, vlan_tci);
1da177e4
LT
260 }
261}
262
263/**
264 * __vlan_get_tag - get the VLAN ID that is part of the payload
265 * @skb: skbuff to query
9bb8582e
PM
266 * @vlan_tci: buffer to store vlaue
267 *
1da177e4
LT
268 * Returns error if the skb is not of VLAN type
269 */
9bb8582e 270static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
1da177e4
LT
271{
272 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
273
57d3ae84 274 if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
1da177e4
LT
275 return -EINVAL;
276 }
277
9bb8582e 278 *vlan_tci = ntohs(veth->h_vlan_TCI);
1da177e4
LT
279 return 0;
280}
281
282/**
283 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
284 * @skb: skbuff to query
9bb8582e
PM
285 * @vlan_tci: buffer to store vlaue
286 *
6aa895b0 287 * Returns error if @skb->vlan_tci is not set correctly
1da177e4 288 */
18149935 289static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
9bb8582e 290 u16 *vlan_tci)
1da177e4 291{
6aa895b0 292 if (vlan_tx_tag_present(skb)) {
05423b24 293 *vlan_tci = vlan_tx_tag_get(skb);
1da177e4
LT
294 return 0;
295 } else {
9bb8582e 296 *vlan_tci = 0;
1da177e4
LT
297 return -EINVAL;
298 }
299}
300
301#define HAVE_VLAN_GET_TAG
302
303/**
304 * vlan_get_tag - get the VLAN ID from the skb
305 * @skb: skbuff to query
9bb8582e
PM
306 * @vlan_tci: buffer to store vlaue
307 *
1da177e4
LT
308 * Returns error if the skb is not VLAN tagged
309 */
9bb8582e 310static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
1da177e4 311{
f646968f 312 if (skb->dev->features & NETIF_F_HW_VLAN_CTAG_TX) {
9bb8582e 313 return __vlan_hwaccel_get_tag(skb, vlan_tci);
1da177e4 314 } else {
9bb8582e 315 return __vlan_get_tag(skb, vlan_tci);
1da177e4
LT
316 }
317}
318
0a85df00
HZ
319/**
320 * vlan_get_protocol - get protocol EtherType.
321 * @skb: skbuff to query
322 *
323 * Returns the EtherType of the packet, regardless of whether it is
324 * vlan encapsulated (normal or hardware accelerated) or not.
325 */
326static inline __be16 vlan_get_protocol(const struct sk_buff *skb)
327{
328 __be16 protocol = 0;
329
330 if (vlan_tx_tag_present(skb) ||
331 skb->protocol != cpu_to_be16(ETH_P_8021Q))
332 protocol = skb->protocol;
333 else {
334 __be16 proto, *protop;
335 protop = skb_header_pointer(skb, offsetof(struct vlan_ethhdr,
336 h_vlan_encapsulated_proto),
337 sizeof(proto), &proto);
338 if (likely(protop))
339 protocol = *protop;
340 }
341
342 return protocol;
343}
396cf943
PS
344
345static inline void vlan_set_encap_proto(struct sk_buff *skb,
346 struct vlan_hdr *vhdr)
347{
348 __be16 proto;
da8c8724 349 unsigned short *rawp;
396cf943
PS
350
351 /*
352 * Was a VLAN packet, grab the encapsulated protocol, which the layer
353 * three protocols care about.
354 */
355
356 proto = vhdr->h_vlan_encapsulated_proto;
e5c5d22e 357 if (ntohs(proto) >= ETH_P_802_3_MIN) {
396cf943
PS
358 skb->protocol = proto;
359 return;
360 }
361
da8c8724
CW
362 rawp = (unsigned short *)(vhdr + 1);
363 if (*rawp == 0xFFFF)
396cf943
PS
364 /*
365 * This is a magic hack to spot IPX packets. Older Novell
366 * breaks the protocol design and runs IPX over 802.3 without
367 * an 802.2 LLC layer. We look for FFFF which isn't a used
368 * 802.2 SSAP/DSAP. This won't work for fault tolerant netware
369 * but does for the rest.
370 */
371 skb->protocol = htons(ETH_P_802_3);
372 else
373 /*
374 * Real 802.2 LLC
375 */
376 skb->protocol = htons(ETH_P_802_2);
377}
1da177e4 378#endif /* !(_LINUX_IF_VLAN_H_) */