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>
19 #include <linux/rtnetlink.h>
21 #define VLAN_HLEN 4 /* The additional bytes (on top of the Ethernet header)
24 #define VLAN_ETH_ALEN 6 /* Octets in one ethernet addr */
25 #define VLAN_ETH_HLEN 18 /* Total octets in header. */
26 #define VLAN_ETH_ZLEN 64 /* Min. octets in frame sans FCS */
29 * According to 802.3ac, the packet can be 4 bytes longer. --Klika Jan
31 #define VLAN_ETH_DATA_LEN 1500 /* Max. octets in payload */
32 #define VLAN_ETH_FRAME_LEN 1518 /* Max. octets in frame sans FCS */
35 * struct vlan_hdr - vlan header
36 * @h_vlan_TCI: priority and VLAN ID
37 * @h_vlan_encapsulated_proto: packet type ID or len
41 __be16 h_vlan_encapsulated_proto;
45 * struct vlan_ethhdr - vlan ethernet header (ethhdr + vlan_hdr)
46 * @h_dest: destination ethernet address
47 * @h_source: source ethernet address
48 * @h_vlan_proto: ethernet protocol (always 0x8100)
49 * @h_vlan_TCI: priority and VLAN ID
50 * @h_vlan_encapsulated_proto: packet type ID or len
53 unsigned char h_dest[ETH_ALEN];
54 unsigned char h_source[ETH_ALEN];
57 __be16 h_vlan_encapsulated_proto;
60 #include <linux/skbuff.h>
62 static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
64 return (struct vlan_ethhdr *)skb_mac_header(skb);
67 #define VLAN_PRIO_MASK 0xe000 /* Priority Code Point */
68 #define VLAN_PRIO_SHIFT 13
69 #define VLAN_CFI_MASK 0x1000 /* Canonical Format Indicator */
70 #define VLAN_TAG_PRESENT VLAN_CFI_MASK
71 #define VLAN_VID_MASK 0x0fff /* VLAN Identifier */
72 #define VLAN_N_VID 4096
74 /* found in socket.c */
75 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
77 /* if this changes, algorithm will have to be reworked because this
78 * depends on completely exhausting the VLAN identifier space. Thus
79 * it gives constant time look-up, but in many cases it wastes memory.
81 #define VLAN_GROUP_ARRAY_SPLIT_PARTS 8
82 #define VLAN_GROUP_ARRAY_PART_LEN (VLAN_N_VID/VLAN_GROUP_ARRAY_SPLIT_PARTS)
85 struct net_device *real_dev; /* The ethernet(like) device
86 * the vlan is attached to.
88 unsigned int nr_vlans;
90 struct hlist_node hlist; /* linked list */
91 struct net_device **vlan_devices_arrays[VLAN_GROUP_ARRAY_SPLIT_PARTS];
95 static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
98 struct net_device **array;
99 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
100 return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
103 static inline void vlan_group_set_device(struct vlan_group *vg,
105 struct net_device *dev)
107 struct net_device **array;
110 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
111 array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
114 #define vlan_tx_tag_present(__skb) ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
115 #define vlan_tx_tag_get(__skb) ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
117 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
118 /* Must be invoked with rcu_read_lock or with RTNL. */
119 static inline struct net_device *vlan_find_dev(struct net_device *real_dev,
122 struct vlan_group *grp = rcu_dereference_rtnl(real_dev->vlgrp);
125 return vlan_group_get_device(grp, vlan_id);
130 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
131 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
133 extern int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
134 u16 vlan_tci, int polling);
135 extern bool vlan_do_receive(struct sk_buff **skb);
136 extern struct sk_buff *vlan_untag(struct sk_buff *skb);
138 vlan_gro_receive(struct napi_struct *napi, struct vlan_group *grp,
139 unsigned int vlan_tci, struct sk_buff *skb);
141 vlan_gro_frags(struct napi_struct *napi, struct vlan_group *grp,
142 unsigned int vlan_tci);
145 static inline struct net_device *vlan_find_dev(struct net_device *real_dev,
151 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
157 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
163 static inline int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
164 u16 vlan_tci, int polling)
167 return NET_XMIT_SUCCESS;
170 static inline bool vlan_do_receive(struct sk_buff **skb)
172 if ((*skb)->vlan_tci & VLAN_VID_MASK)
173 (*skb)->pkt_type = PACKET_OTHERHOST;
177 inline struct sk_buff *vlan_untag(struct sk_buff *skb)
182 static inline gro_result_t
183 vlan_gro_receive(struct napi_struct *napi, struct vlan_group *grp,
184 unsigned int vlan_tci, struct sk_buff *skb)
189 static inline gro_result_t
190 vlan_gro_frags(struct napi_struct *napi, struct vlan_group *grp,
191 unsigned int vlan_tci)
198 * vlan_hwaccel_rx - netif_rx wrapper for VLAN RX acceleration
201 * @vlan_tci: VLAN TCI as received from the card
203 static inline int vlan_hwaccel_rx(struct sk_buff *skb,
204 struct vlan_group *grp,
207 return __vlan_hwaccel_rx(skb, grp, vlan_tci, 0);
211 * vlan_hwaccel_receive_skb - netif_receive_skb wrapper for VLAN RX acceleration
214 * @vlan_tci: VLAN TCI as received from the card
216 static inline int vlan_hwaccel_receive_skb(struct sk_buff *skb,
217 struct vlan_group *grp,
220 return __vlan_hwaccel_rx(skb, grp, vlan_tci, 1);
224 * __vlan_put_tag - regular VLAN tag inserting
225 * @skb: skbuff to tag
226 * @vlan_tci: VLAN TCI to insert
228 * Inserts the VLAN tag into @skb as part of the payload
229 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
231 * Following the skb_unshare() example, in case of error, the calling function
232 * doesn't have to worry about freeing the original skb.
234 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
236 struct vlan_ethhdr *veth;
238 if (skb_cow_head(skb, VLAN_HLEN) < 0) {
242 veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
244 /* Move the mac addresses to the beginning of the new header. */
245 memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
246 skb->mac_header -= VLAN_HLEN;
248 /* first, the ethernet type */
249 veth->h_vlan_proto = htons(ETH_P_8021Q);
252 veth->h_vlan_TCI = htons(vlan_tci);
254 skb->protocol = htons(ETH_P_8021Q);
260 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
261 * @skb: skbuff to tag
262 * @vlan_tci: VLAN TCI to insert
264 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
266 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
269 skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
273 #define HAVE_VLAN_PUT_TAG
276 * vlan_put_tag - inserts VLAN tag according to device features
277 * @skb: skbuff to tag
278 * @vlan_tci: VLAN TCI to insert
280 * Assumes skb->dev is the target that will xmit this frame.
281 * Returns a VLAN tagged skb.
283 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
285 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
286 return __vlan_hwaccel_put_tag(skb, vlan_tci);
288 return __vlan_put_tag(skb, vlan_tci);
293 * __vlan_get_tag - get the VLAN ID that is part of the payload
294 * @skb: skbuff to query
295 * @vlan_tci: buffer to store vlaue
297 * Returns error if the skb is not of VLAN type
299 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
301 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
303 if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
307 *vlan_tci = ntohs(veth->h_vlan_TCI);
312 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
313 * @skb: skbuff to query
314 * @vlan_tci: buffer to store vlaue
316 * Returns error if @skb->vlan_tci is not set correctly
318 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
321 if (vlan_tx_tag_present(skb)) {
322 *vlan_tci = vlan_tx_tag_get(skb);
330 #define HAVE_VLAN_GET_TAG
333 * vlan_get_tag - get the VLAN ID from the skb
334 * @skb: skbuff to query
335 * @vlan_tci: buffer to store vlaue
337 * Returns error if the skb is not VLAN tagged
339 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
341 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
342 return __vlan_hwaccel_get_tag(skb, vlan_tci);
344 return __vlan_get_tag(skb, vlan_tci);
349 * vlan_get_protocol - get protocol EtherType.
350 * @skb: skbuff to query
352 * Returns the EtherType of the packet, regardless of whether it is
353 * vlan encapsulated (normal or hardware accelerated) or not.
355 static inline __be16 vlan_get_protocol(const struct sk_buff *skb)
359 if (vlan_tx_tag_present(skb) ||
360 skb->protocol != cpu_to_be16(ETH_P_8021Q))
361 protocol = skb->protocol;
363 __be16 proto, *protop;
364 protop = skb_header_pointer(skb, offsetof(struct vlan_ethhdr,
365 h_vlan_encapsulated_proto),
366 sizeof(proto), &proto);
373 #endif /* __KERNEL__ */
375 /* VLAN IOCTLs are found in sockios.h */
377 /* Passed in vlan_ioctl_args structure to determine behaviour. */
378 enum vlan_ioctl_cmds {
381 SET_VLAN_INGRESS_PRIORITY_CMD,
382 SET_VLAN_EGRESS_PRIORITY_CMD,
383 GET_VLAN_INGRESS_PRIORITY_CMD,
384 GET_VLAN_EGRESS_PRIORITY_CMD,
385 SET_VLAN_NAME_TYPE_CMD,
387 GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
388 GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
392 VLAN_FLAG_REORDER_HDR = 0x1,
393 VLAN_FLAG_GVRP = 0x2,
394 VLAN_FLAG_LOOSE_BINDING = 0x4,
397 enum vlan_name_types {
398 VLAN_NAME_TYPE_PLUS_VID, /* Name will look like: vlan0005 */
399 VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like: eth1.0005 */
400 VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like: vlan5 */
401 VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like: eth0.5 */
402 VLAN_NAME_TYPE_HIGHEST
405 struct vlan_ioctl_args {
406 int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
412 unsigned int skb_priority;
413 unsigned int name_type;
414 unsigned int bind_type;
415 unsigned int flag; /* Matches vlan_dev_info flags */
421 #endif /* !(_LINUX_IF_VLAN_H_) */