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_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 */
72 /* found in socket.c */
73 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
75 /* if this changes, algorithm will have to be reworked because this
76 * depends on completely exhausting the VLAN identifier space. Thus
77 * it gives constant time look-up, but in many cases it wastes memory.
79 #define VLAN_GROUP_ARRAY_LEN 4096
80 #define VLAN_GROUP_ARRAY_SPLIT_PARTS 8
81 #define VLAN_GROUP_ARRAY_PART_LEN (VLAN_GROUP_ARRAY_LEN/VLAN_GROUP_ARRAY_SPLIT_PARTS)
84 struct net_device *real_dev; /* The ethernet(like) device
85 * the vlan is attached to.
87 unsigned int nr_vlans;
89 struct hlist_node hlist; /* linked list */
90 struct net_device **vlan_devices_arrays[VLAN_GROUP_ARRAY_SPLIT_PARTS];
94 static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
97 struct net_device **array;
98 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
99 return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
102 static inline void vlan_group_set_device(struct vlan_group *vg,
104 struct net_device *dev)
106 struct net_device **array;
109 array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
110 array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
113 #define vlan_tx_tag_present(__skb) ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
114 #define vlan_tx_tag_get(__skb) ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
116 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
117 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
118 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
120 extern int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
121 u16 vlan_tci, int polling);
122 extern int vlan_hwaccel_do_receive(struct sk_buff *skb);
123 extern int vlan_gro_receive(struct napi_struct *napi, struct vlan_group *grp,
124 unsigned int vlan_tci, struct sk_buff *skb);
125 extern int vlan_gro_frags(struct napi_struct *napi, struct vlan_group *grp,
126 unsigned int vlan_tci);
129 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
135 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
141 static inline int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
142 u16 vlan_tci, int polling)
145 return NET_XMIT_SUCCESS;
148 static inline int vlan_hwaccel_do_receive(struct sk_buff *skb)
153 static inline int vlan_gro_receive(struct napi_struct *napi,
154 struct vlan_group *grp,
155 unsigned int vlan_tci, struct sk_buff *skb)
160 static inline int vlan_gro_frags(struct napi_struct *napi,
161 struct vlan_group *grp, unsigned int vlan_tci)
168 * vlan_hwaccel_rx - netif_rx wrapper for VLAN RX acceleration
171 * @vlan_tci: VLAN TCI as received from the card
173 static inline int vlan_hwaccel_rx(struct sk_buff *skb,
174 struct vlan_group *grp,
177 return __vlan_hwaccel_rx(skb, grp, vlan_tci, 0);
181 * vlan_hwaccel_receive_skb - netif_receive_skb wrapper for VLAN RX acceleration
184 * @vlan_tci: VLAN TCI as received from the card
186 static inline int vlan_hwaccel_receive_skb(struct sk_buff *skb,
187 struct vlan_group *grp,
190 return __vlan_hwaccel_rx(skb, grp, vlan_tci, 1);
194 * __vlan_put_tag - regular VLAN tag inserting
195 * @skb: skbuff to tag
196 * @vlan_tci: VLAN TCI to insert
198 * Inserts the VLAN tag into @skb as part of the payload
199 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
201 * Following the skb_unshare() example, in case of error, the calling function
202 * doesn't have to worry about freeing the original skb.
204 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
206 struct vlan_ethhdr *veth;
208 if (skb_cow_head(skb, VLAN_HLEN) < 0) {
212 veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
214 /* Move the mac addresses to the beginning of the new header. */
215 memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
216 skb->mac_header -= VLAN_HLEN;
218 /* first, the ethernet type */
219 veth->h_vlan_proto = htons(ETH_P_8021Q);
222 veth->h_vlan_TCI = htons(vlan_tci);
224 skb->protocol = htons(ETH_P_8021Q);
230 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
231 * @skb: skbuff to tag
232 * @vlan_tci: VLAN TCI to insert
234 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
236 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
239 skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
243 #define HAVE_VLAN_PUT_TAG
246 * vlan_put_tag - inserts VLAN tag according to device features
247 * @skb: skbuff to tag
248 * @vlan_tci: VLAN TCI to insert
250 * Assumes skb->dev is the target that will xmit this frame.
251 * Returns a VLAN tagged skb.
253 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
255 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
256 return __vlan_hwaccel_put_tag(skb, vlan_tci);
258 return __vlan_put_tag(skb, vlan_tci);
263 * __vlan_get_tag - get the VLAN ID that is part of the payload
264 * @skb: skbuff to query
265 * @vlan_tci: buffer to store vlaue
267 * Returns error if the skb is not of VLAN type
269 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
271 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
273 if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
277 *vlan_tci = ntohs(veth->h_vlan_TCI);
282 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
283 * @skb: skbuff to query
284 * @vlan_tci: buffer to store vlaue
286 * Returns error if @skb->vlan_tci is not set correctly
288 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
291 if (vlan_tx_tag_present(skb)) {
292 *vlan_tci = vlan_tx_tag_get(skb);
300 #define HAVE_VLAN_GET_TAG
303 * vlan_get_tag - get the VLAN ID from the skb
304 * @skb: skbuff to query
305 * @vlan_tci: buffer to store vlaue
307 * Returns error if the skb is not VLAN tagged
309 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
311 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
312 return __vlan_hwaccel_get_tag(skb, vlan_tci);
314 return __vlan_get_tag(skb, vlan_tci);
318 #endif /* __KERNEL__ */
320 /* VLAN IOCTLs are found in sockios.h */
322 /* Passed in vlan_ioctl_args structure to determine behaviour. */
323 enum vlan_ioctl_cmds {
326 SET_VLAN_INGRESS_PRIORITY_CMD,
327 SET_VLAN_EGRESS_PRIORITY_CMD,
328 GET_VLAN_INGRESS_PRIORITY_CMD,
329 GET_VLAN_EGRESS_PRIORITY_CMD,
330 SET_VLAN_NAME_TYPE_CMD,
332 GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
333 GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
337 VLAN_FLAG_REORDER_HDR = 0x1,
338 VLAN_FLAG_GVRP = 0x2,
341 enum vlan_name_types {
342 VLAN_NAME_TYPE_PLUS_VID, /* Name will look like: vlan0005 */
343 VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like: eth1.0005 */
344 VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like: vlan5 */
345 VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like: eth0.5 */
346 VLAN_NAME_TYPE_HIGHEST
349 struct vlan_ioctl_args {
350 int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
356 unsigned int skb_priority;
357 unsigned int name_type;
358 unsigned int bind_type;
359 unsigned int flag; /* Matches vlan_dev_info flags */
365 #endif /* !(_LINUX_IF_VLAN_H_) */