2 * VLAN An implementation of 802.1Q VLAN tagging.
4 * Authors: Ben Greear <greearb@candelatech.com>
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.
13 #ifndef _LINUX_IF_VLAN_H_
14 #define _LINUX_IF_VLAN_H_
17 #include <linux/netdevice.h>
18 #include <linux/etherdevice.h>
20 #define VLAN_HLEN 4 /* The additional bytes (on top of the Ethernet header)
23 #define VLAN_ETH_ALEN 6 /* Octets in one ethernet addr */
24 #define VLAN_ETH_HLEN 18 /* Total octets in header. */
25 #define VLAN_ETH_ZLEN 64 /* Min. octets in frame sans FCS */
28 * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
30 #define VLAN_ETH_DATA_LEN 1500 /* Max. octets in payload */
31 #define VLAN_ETH_FRAME_LEN 1518 /* Max. octets in frame sans FCS */
34 * struct vlan_hdr - vlan header
35 * @h_vlan_TCI: priority and VLAN ID
36 * @h_vlan_encapsulated_proto: packet type ID or len
40 __be16 h_vlan_encapsulated_proto;
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
52 unsigned char h_dest[ETH_ALEN];
53 unsigned char h_source[ETH_ALEN];
56 __be16 h_vlan_encapsulated_proto;
59 #include <linux/skbuff.h>
61 static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
63 return (struct vlan_ethhdr *)skb_mac_header(skb);
66 #define VLAN_VID_MASK 0xfff
68 /* found in socket.c */
69 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
71 /* if this changes, algorithm will have to be reworked because this
72 * depends on completely exhausting the VLAN identifier space. Thus
73 * it gives constant time look-up, but in many cases it wastes memory.
75 #define VLAN_GROUP_ARRAY_LEN 4096
76 #define VLAN_GROUP_ARRAY_SPLIT_PARTS 8
77 #define VLAN_GROUP_ARRAY_PART_LEN (VLAN_GROUP_ARRAY_LEN/VLAN_GROUP_ARRAY_SPLIT_PARTS)
80 struct net_device *real_dev; /* The ethernet(like) device
81 * the vlan is attached to.
83 unsigned int nr_vlans;
84 struct hlist_node hlist; /* linked list */
85 struct net_device **vlan_devices_arrays[VLAN_GROUP_ARRAY_SPLIT_PARTS];
89 static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
92 struct net_device **array;
93 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
94 return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
97 static inline void vlan_group_set_device(struct vlan_group *vg,
99 struct net_device *dev)
101 struct net_device **array;
104 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
105 array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
108 /* VLAN tx hw acceleration helpers. */
109 struct vlan_skb_tx_cookie {
114 #define VLAN_TX_COOKIE_MAGIC 0x564c414e /* "VLAN" in ascii. */
115 #define VLAN_TX_SKB_CB(__skb) ((struct vlan_skb_tx_cookie *)&((__skb)->cb[0]))
116 #define vlan_tx_tag_present(__skb) \
117 (VLAN_TX_SKB_CB(__skb)->magic == VLAN_TX_COOKIE_MAGIC)
118 #define vlan_tx_tag_get(__skb) (VLAN_TX_SKB_CB(__skb)->vlan_tag)
120 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
121 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
122 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
124 extern int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
125 u16 vlan_tci, int polling);
127 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
133 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
139 static inline int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
140 u16 vlan_tci, int polling)
143 return NET_XMIT_SUCCESS;
148 * vlan_hwaccel_rx - netif_rx wrapper for VLAN RX acceleration
151 * @vlan_tci: VLAN TCI as received from the card
153 static inline int vlan_hwaccel_rx(struct sk_buff *skb,
154 struct vlan_group *grp,
157 return __vlan_hwaccel_rx(skb, grp, vlan_tci, 0);
161 * vlan_hwaccel_receive_skb - netif_receive_skb wrapper for VLAN RX acceleration
164 * @vlan_tci: VLAN TCI as received from the card
166 static inline int vlan_hwaccel_receive_skb(struct sk_buff *skb,
167 struct vlan_group *grp,
170 return __vlan_hwaccel_rx(skb, grp, vlan_tci, 1);
174 * __vlan_put_tag - regular VLAN tag inserting
175 * @skb: skbuff to tag
176 * @vlan_tci: VLAN TCI to insert
178 * Inserts the VLAN tag into @skb as part of the payload
179 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
181 * Following the skb_unshare() example, in case of error, the calling function
182 * doesn't have to worry about freeing the original skb.
184 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
186 struct vlan_ethhdr *veth;
188 if (skb_cow_head(skb, VLAN_HLEN) < 0) {
192 veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
194 /* Move the mac addresses to the beginning of the new header. */
195 memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
197 /* first, the ethernet type */
198 veth->h_vlan_proto = htons(ETH_P_8021Q);
201 veth->h_vlan_TCI = htons(vlan_tci);
203 skb->protocol = htons(ETH_P_8021Q);
209 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
210 * @skb: skbuff to tag
211 * @vlan_tci: VLAN TCI to insert
213 * Puts the VLAN TCI in @skb->cb[] and lets the device do the rest
215 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
218 struct vlan_skb_tx_cookie *cookie;
220 cookie = VLAN_TX_SKB_CB(skb);
221 cookie->magic = VLAN_TX_COOKIE_MAGIC;
222 cookie->vlan_tag = vlan_tci;
227 #define HAVE_VLAN_PUT_TAG
230 * vlan_put_tag - inserts VLAN tag according to device features
231 * @skb: skbuff to tag
232 * @vlan_tci: VLAN TCI to insert
234 * Assumes skb->dev is the target that will xmit this frame.
235 * Returns a VLAN tagged skb.
237 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
239 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
240 return __vlan_hwaccel_put_tag(skb, vlan_tci);
242 return __vlan_put_tag(skb, vlan_tci);
247 * __vlan_get_tag - get the VLAN ID that is part of the payload
248 * @skb: skbuff to query
249 * @vlan_tci: buffer to store vlaue
251 * Returns error if the skb is not of VLAN type
253 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
255 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
257 if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
261 *vlan_tci = ntohs(veth->h_vlan_TCI);
266 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
267 * @skb: skbuff to query
268 * @vlan_tci: buffer to store vlaue
270 * Returns error if @skb->cb[] is not set correctly
272 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
275 struct vlan_skb_tx_cookie *cookie;
277 cookie = VLAN_TX_SKB_CB(skb);
278 if (cookie->magic == VLAN_TX_COOKIE_MAGIC) {
279 *vlan_tci = cookie->vlan_tag;
287 #define HAVE_VLAN_GET_TAG
290 * vlan_get_tag - get the VLAN ID from the skb
291 * @skb: skbuff to query
292 * @vlan_tci: buffer to store vlaue
294 * Returns error if the skb is not VLAN tagged
296 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
298 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
299 return __vlan_hwaccel_get_tag(skb, vlan_tci);
301 return __vlan_get_tag(skb, vlan_tci);
305 #endif /* __KERNEL__ */
307 /* VLAN IOCTLs are found in sockios.h */
309 /* Passed in vlan_ioctl_args structure to determine behaviour. */
310 enum vlan_ioctl_cmds {
313 SET_VLAN_INGRESS_PRIORITY_CMD,
314 SET_VLAN_EGRESS_PRIORITY_CMD,
315 GET_VLAN_INGRESS_PRIORITY_CMD,
316 GET_VLAN_EGRESS_PRIORITY_CMD,
317 SET_VLAN_NAME_TYPE_CMD,
319 GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
320 GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
324 VLAN_FLAG_REORDER_HDR = 0x1,
325 VLAN_FLAG_GVRP = 0x2,
328 enum vlan_name_types {
329 VLAN_NAME_TYPE_PLUS_VID, /* Name will look like: vlan0005 */
330 VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like: eth1.0005 */
331 VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like: vlan5 */
332 VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like: eth0.5 */
333 VLAN_NAME_TYPE_HIGHEST
336 struct vlan_ioctl_args {
337 int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
343 unsigned int skb_priority;
344 unsigned int name_type;
345 unsigned int bind_type;
346 unsigned int flag; /* Matches vlan_dev_info flags */
352 #endif /* !(_LINUX_IF_VLAN_H_) */