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 #define vlan_tx_tag_present(__skb) ((__skb)->vlan_tci)
109 #define vlan_tx_tag_get(__skb) ((__skb)->vlan_tci)
111 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
112 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
113 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
115 extern int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
116 u16 vlan_tci, int polling);
117 extern int vlan_hwaccel_do_receive(struct sk_buff *skb);
118 extern int vlan_gro_receive(struct napi_struct *napi, struct vlan_group *grp,
119 unsigned int vlan_tci, struct sk_buff *skb);
120 extern int vlan_gro_frags(struct napi_struct *napi, struct vlan_group *grp,
121 unsigned int vlan_tci,
122 struct napi_gro_fraginfo *info);
125 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
131 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
137 static inline int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
138 u16 vlan_tci, int polling)
141 return NET_XMIT_SUCCESS;
144 static inline int vlan_hwaccel_do_receive(struct sk_buff *skb)
149 static inline int vlan_gro_receive(struct napi_struct *napi,
150 struct vlan_group *grp,
151 unsigned int vlan_tci, struct sk_buff *skb)
156 static inline int vlan_gro_frags(struct napi_struct *napi,
157 struct vlan_group *grp, unsigned int vlan_tci,
158 struct napi_gro_fraginfo *info)
165 * vlan_hwaccel_rx - netif_rx wrapper for VLAN RX acceleration
168 * @vlan_tci: VLAN TCI as received from the card
170 static inline int vlan_hwaccel_rx(struct sk_buff *skb,
171 struct vlan_group *grp,
174 return __vlan_hwaccel_rx(skb, grp, vlan_tci, 0);
178 * vlan_hwaccel_receive_skb - netif_receive_skb wrapper for VLAN RX acceleration
181 * @vlan_tci: VLAN TCI as received from the card
183 static inline int vlan_hwaccel_receive_skb(struct sk_buff *skb,
184 struct vlan_group *grp,
187 return __vlan_hwaccel_rx(skb, grp, vlan_tci, 1);
191 * __vlan_put_tag - regular VLAN tag inserting
192 * @skb: skbuff to tag
193 * @vlan_tci: VLAN TCI to insert
195 * Inserts the VLAN tag into @skb as part of the payload
196 * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
198 * Following the skb_unshare() example, in case of error, the calling function
199 * doesn't have to worry about freeing the original skb.
201 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
203 struct vlan_ethhdr *veth;
205 if (skb_cow_head(skb, VLAN_HLEN) < 0) {
209 veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
211 /* Move the mac addresses to the beginning of the new header. */
212 memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
213 skb->mac_header -= VLAN_HLEN;
215 /* first, the ethernet type */
216 veth->h_vlan_proto = htons(ETH_P_8021Q);
219 veth->h_vlan_TCI = htons(vlan_tci);
221 skb->protocol = htons(ETH_P_8021Q);
227 * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
228 * @skb: skbuff to tag
229 * @vlan_tci: VLAN TCI to insert
231 * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
233 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
236 skb->vlan_tci = vlan_tci;
240 #define HAVE_VLAN_PUT_TAG
243 * vlan_put_tag - inserts VLAN tag according to device features
244 * @skb: skbuff to tag
245 * @vlan_tci: VLAN TCI to insert
247 * Assumes skb->dev is the target that will xmit this frame.
248 * Returns a VLAN tagged skb.
250 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
252 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
253 return __vlan_hwaccel_put_tag(skb, vlan_tci);
255 return __vlan_put_tag(skb, vlan_tci);
260 * __vlan_get_tag - get the VLAN ID that is part of the payload
261 * @skb: skbuff to query
262 * @vlan_tci: buffer to store vlaue
264 * Returns error if the skb is not of VLAN type
266 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
268 struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
270 if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
274 *vlan_tci = ntohs(veth->h_vlan_TCI);
279 * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
280 * @skb: skbuff to query
281 * @vlan_tci: buffer to store vlaue
283 * Returns error if @skb->vlan_tci is not set correctly
285 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
288 if (vlan_tx_tag_present(skb)) {
289 *vlan_tci = skb->vlan_tci;
297 #define HAVE_VLAN_GET_TAG
300 * vlan_get_tag - get the VLAN ID from the skb
301 * @skb: skbuff to query
302 * @vlan_tci: buffer to store vlaue
304 * Returns error if the skb is not VLAN tagged
306 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
308 if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
309 return __vlan_hwaccel_get_tag(skb, vlan_tci);
311 return __vlan_get_tag(skb, vlan_tci);
315 #endif /* __KERNEL__ */
317 /* VLAN IOCTLs are found in sockios.h */
319 /* Passed in vlan_ioctl_args structure to determine behaviour. */
320 enum vlan_ioctl_cmds {
323 SET_VLAN_INGRESS_PRIORITY_CMD,
324 SET_VLAN_EGRESS_PRIORITY_CMD,
325 GET_VLAN_INGRESS_PRIORITY_CMD,
326 GET_VLAN_EGRESS_PRIORITY_CMD,
327 SET_VLAN_NAME_TYPE_CMD,
329 GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
330 GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
334 VLAN_FLAG_REORDER_HDR = 0x1,
335 VLAN_FLAG_GVRP = 0x2,
338 enum vlan_name_types {
339 VLAN_NAME_TYPE_PLUS_VID, /* Name will look like: vlan0005 */
340 VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like: eth1.0005 */
341 VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like: vlan5 */
342 VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like: eth0.5 */
343 VLAN_NAME_TYPE_HIGHEST
346 struct vlan_ioctl_args {
347 int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
353 unsigned int skb_priority;
354 unsigned int name_type;
355 unsigned int bind_type;
356 unsigned int flag; /* Matches vlan_dev_info flags */
362 #endif /* !(_LINUX_IF_VLAN_H_) */