8898cbebcf340a16a9085de7471b7e3a22a55f5b
[safe/jmp/linux-2.6] / include / linux / if_vlan.h
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  */
12
13 #ifndef _LINUX_IF_VLAN_H_
14 #define _LINUX_IF_VLAN_H_
15
16 #ifdef __KERNEL__
17 #include <linux/netdevice.h>
18 #include <linux/etherdevice.h>
19
20 #define VLAN_HLEN       4               /* The additional bytes (on top of the Ethernet header)
21                                          * that VLAN requires.
22                                          */
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 */
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
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  */
38 struct 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  */
51 struct vlan_ethhdr {
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;
57 };
58
59 #include <linux/skbuff.h>
60
61 static inline struct vlan_ethhdr *vlan_eth_hdr(const struct sk_buff *skb)
62 {
63         return (struct vlan_ethhdr *)skb_mac_header(skb);
64 }
65
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 */
71
72 /* found in socket.c */
73 extern void vlan_ioctl_set(int (*hook)(struct net *, void __user *));
74
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.
78  */
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)
82
83 struct vlan_group {
84         struct net_device       *real_dev; /* The ethernet(like) device
85                                             * the vlan is attached to.
86                                             */
87         unsigned int            nr_vlans;
88         struct hlist_node       hlist;  /* linked list */
89         struct net_device **vlan_devices_arrays[VLAN_GROUP_ARRAY_SPLIT_PARTS];
90         struct rcu_head         rcu;
91 };
92
93 static inline struct net_device *vlan_group_get_device(struct vlan_group *vg,
94                                                        u16 vlan_id)
95 {
96         struct net_device **array;
97         array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
98         return array ? array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] : NULL;
99 }
100
101 static inline void vlan_group_set_device(struct vlan_group *vg,
102                                          u16 vlan_id,
103                                          struct net_device *dev)
104 {
105         struct net_device **array;
106         if (!vg)
107                 return;
108         array = vg->vlan_devices_arrays[vlan_id / VLAN_GROUP_ARRAY_PART_LEN];
109         array[vlan_id % VLAN_GROUP_ARRAY_PART_LEN] = dev;
110 }
111
112 #define vlan_tx_tag_present(__skb)      ((__skb)->vlan_tci & VLAN_TAG_PRESENT)
113 #define vlan_tx_tag_get(__skb)          ((__skb)->vlan_tci & ~VLAN_TAG_PRESENT)
114
115 #if defined(CONFIG_VLAN_8021Q) || defined(CONFIG_VLAN_8021Q_MODULE)
116 extern struct net_device *vlan_dev_real_dev(const struct net_device *dev);
117 extern u16 vlan_dev_vlan_id(const struct net_device *dev);
118
119 extern int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
120                              u16 vlan_tci, int polling);
121 extern int vlan_hwaccel_do_receive(struct sk_buff *skb);
122 extern int vlan_gro_receive(struct napi_struct *napi, struct vlan_group *grp,
123                             unsigned int vlan_tci, struct sk_buff *skb);
124 extern int vlan_gro_frags(struct napi_struct *napi, struct vlan_group *grp,
125                           unsigned int vlan_tci);
126
127 #else
128 static inline struct net_device *vlan_dev_real_dev(const struct net_device *dev)
129 {
130         BUG();
131         return NULL;
132 }
133
134 static inline u16 vlan_dev_vlan_id(const struct net_device *dev)
135 {
136         BUG();
137         return 0;
138 }
139
140 static inline int __vlan_hwaccel_rx(struct sk_buff *skb, struct vlan_group *grp,
141                                     u16 vlan_tci, int polling)
142 {
143         BUG();
144         return NET_XMIT_SUCCESS;
145 }
146
147 static inline int vlan_hwaccel_do_receive(struct sk_buff *skb)
148 {
149         return 0;
150 }
151
152 static inline int vlan_gro_receive(struct napi_struct *napi,
153                                    struct vlan_group *grp,
154                                    unsigned int vlan_tci, struct sk_buff *skb)
155 {
156         return NET_RX_DROP;
157 }
158
159 static inline int vlan_gro_frags(struct napi_struct *napi,
160                                  struct vlan_group *grp, unsigned int vlan_tci)
161 {
162         return NET_RX_DROP;
163 }
164 #endif
165
166 /**
167  * vlan_hwaccel_rx - netif_rx wrapper for VLAN RX acceleration
168  * @skb: buffer
169  * @grp: vlan group
170  * @vlan_tci: VLAN TCI as received from the card
171  */
172 static inline int vlan_hwaccel_rx(struct sk_buff *skb,
173                                   struct vlan_group *grp,
174                                   u16 vlan_tci)
175 {
176         return __vlan_hwaccel_rx(skb, grp, vlan_tci, 0);
177 }
178
179 /**
180  * vlan_hwaccel_receive_skb - netif_receive_skb wrapper for VLAN RX acceleration
181  * @skb: buffer
182  * @grp: vlan group
183  * @vlan_tci: VLAN TCI as received from the card
184  */
185 static inline int vlan_hwaccel_receive_skb(struct sk_buff *skb,
186                                            struct vlan_group *grp,
187                                            u16 vlan_tci)
188 {
189         return __vlan_hwaccel_rx(skb, grp, vlan_tci, 1);
190 }
191
192 /**
193  * __vlan_put_tag - regular VLAN tag inserting
194  * @skb: skbuff to tag
195  * @vlan_tci: VLAN TCI to insert
196  *
197  * Inserts the VLAN tag into @skb as part of the payload
198  * Returns a VLAN tagged skb. If a new skb is created, @skb is freed.
199  *
200  * Following the skb_unshare() example, in case of error, the calling function
201  * doesn't have to worry about freeing the original skb.
202  */
203 static inline struct sk_buff *__vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
204 {
205         struct vlan_ethhdr *veth;
206
207         if (skb_cow_head(skb, VLAN_HLEN) < 0) {
208                 kfree_skb(skb);
209                 return NULL;
210         }
211         veth = (struct vlan_ethhdr *)skb_push(skb, VLAN_HLEN);
212
213         /* Move the mac addresses to the beginning of the new header. */
214         memmove(skb->data, skb->data + VLAN_HLEN, 2 * VLAN_ETH_ALEN);
215         skb->mac_header -= VLAN_HLEN;
216
217         /* first, the ethernet type */
218         veth->h_vlan_proto = htons(ETH_P_8021Q);
219
220         /* now, the TCI */
221         veth->h_vlan_TCI = htons(vlan_tci);
222
223         skb->protocol = htons(ETH_P_8021Q);
224
225         return skb;
226 }
227
228 /**
229  * __vlan_hwaccel_put_tag - hardware accelerated VLAN inserting
230  * @skb: skbuff to tag
231  * @vlan_tci: VLAN TCI to insert
232  *
233  * Puts the VLAN TCI in @skb->vlan_tci and lets the device do the rest
234  */
235 static inline struct sk_buff *__vlan_hwaccel_put_tag(struct sk_buff *skb,
236                                                      u16 vlan_tci)
237 {
238         skb->vlan_tci = VLAN_TAG_PRESENT | vlan_tci;
239         return skb;
240 }
241
242 #define HAVE_VLAN_PUT_TAG
243
244 /**
245  * vlan_put_tag - inserts VLAN tag according to device features
246  * @skb: skbuff to tag
247  * @vlan_tci: VLAN TCI to insert
248  *
249  * Assumes skb->dev is the target that will xmit this frame.
250  * Returns a VLAN tagged skb.
251  */
252 static inline struct sk_buff *vlan_put_tag(struct sk_buff *skb, u16 vlan_tci)
253 {
254         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
255                 return __vlan_hwaccel_put_tag(skb, vlan_tci);
256         } else {
257                 return __vlan_put_tag(skb, vlan_tci);
258         }
259 }
260
261 /**
262  * __vlan_get_tag - get the VLAN ID that is part of the payload
263  * @skb: skbuff to query
264  * @vlan_tci: buffer to store vlaue
265  *
266  * Returns error if the skb is not of VLAN type
267  */
268 static inline int __vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
269 {
270         struct vlan_ethhdr *veth = (struct vlan_ethhdr *)skb->data;
271
272         if (veth->h_vlan_proto != htons(ETH_P_8021Q)) {
273                 return -EINVAL;
274         }
275
276         *vlan_tci = ntohs(veth->h_vlan_TCI);
277         return 0;
278 }
279
280 /**
281  * __vlan_hwaccel_get_tag - get the VLAN ID that is in @skb->cb[]
282  * @skb: skbuff to query
283  * @vlan_tci: buffer to store vlaue
284  *
285  * Returns error if @skb->vlan_tci is not set correctly
286  */
287 static inline int __vlan_hwaccel_get_tag(const struct sk_buff *skb,
288                                          u16 *vlan_tci)
289 {
290         if (vlan_tx_tag_present(skb)) {
291                 *vlan_tci = vlan_tx_tag_get(skb);
292                 return 0;
293         } else {
294                 *vlan_tci = 0;
295                 return -EINVAL;
296         }
297 }
298
299 #define HAVE_VLAN_GET_TAG
300
301 /**
302  * vlan_get_tag - get the VLAN ID from the skb
303  * @skb: skbuff to query
304  * @vlan_tci: buffer to store vlaue
305  *
306  * Returns error if the skb is not VLAN tagged
307  */
308 static inline int vlan_get_tag(const struct sk_buff *skb, u16 *vlan_tci)
309 {
310         if (skb->dev->features & NETIF_F_HW_VLAN_TX) {
311                 return __vlan_hwaccel_get_tag(skb, vlan_tci);
312         } else {
313                 return __vlan_get_tag(skb, vlan_tci);
314         }
315 }
316
317 #endif /* __KERNEL__ */
318
319 /* VLAN IOCTLs are found in sockios.h */
320
321 /* Passed in vlan_ioctl_args structure to determine behaviour. */
322 enum vlan_ioctl_cmds {
323         ADD_VLAN_CMD,
324         DEL_VLAN_CMD,
325         SET_VLAN_INGRESS_PRIORITY_CMD,
326         SET_VLAN_EGRESS_PRIORITY_CMD,
327         GET_VLAN_INGRESS_PRIORITY_CMD,
328         GET_VLAN_EGRESS_PRIORITY_CMD,
329         SET_VLAN_NAME_TYPE_CMD,
330         SET_VLAN_FLAG_CMD,
331         GET_VLAN_REALDEV_NAME_CMD, /* If this works, you know it's a VLAN device, btw */
332         GET_VLAN_VID_CMD /* Get the VID of this VLAN (specified by name) */
333 };
334
335 enum vlan_flags {
336         VLAN_FLAG_REORDER_HDR   = 0x1,
337         VLAN_FLAG_GVRP          = 0x2,
338 };
339
340 enum vlan_name_types {
341         VLAN_NAME_TYPE_PLUS_VID, /* Name will look like:  vlan0005 */
342         VLAN_NAME_TYPE_RAW_PLUS_VID, /* name will look like:  eth1.0005 */
343         VLAN_NAME_TYPE_PLUS_VID_NO_PAD, /* Name will look like:  vlan5 */
344         VLAN_NAME_TYPE_RAW_PLUS_VID_NO_PAD, /* Name will look like:  eth0.5 */
345         VLAN_NAME_TYPE_HIGHEST
346 };
347
348 struct vlan_ioctl_args {
349         int cmd; /* Should be one of the vlan_ioctl_cmds enum above. */
350         char device1[24];
351
352         union {
353                 char device2[24];
354                 int VID;
355                 unsigned int skb_priority;
356                 unsigned int name_type;
357                 unsigned int bind_type;
358                 unsigned int flag; /* Matches vlan_dev_info flags */
359         } u;
360
361         short vlan_qos;   
362 };
363
364 #endif /* !(_LINUX_IF_VLAN_H_) */