blob: d8b512496e50c155e99712f5226e115159beabc1 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * INET An implementation of the TCP/IP protocol suite for the LINUX
3 * operating system. NET is implemented using the BSD Socket
4 * interface as the means of communication with the user level.
5 *
6 * Definitions for the Ethernet handlers.
7 *
8 * Version: @(#)eth.h 1.0.4 05/13/93
9 *
Jesper Juhl02c30a82005-05-05 16:16:16 -070010 * Authors: Ross Biro
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
12 *
13 * Relocated to include/linux where it belongs by Alan Cox
14 * <gw4pts@gw4pts.ampr.org>
15 *
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License
18 * as published by the Free Software Foundation; either version
19 * 2 of the License, or (at your option) any later version.
20 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 */
22#ifndef _LINUX_ETHERDEVICE_H
23#define _LINUX_ETHERDEVICE_H
24
25#include <linux/if_ether.h>
Arnd Bergmannbcd61272005-06-28 15:58:50 -070026#include <linux/netdevice.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/random.h>
Eric Dumazet1f87e232008-11-23 23:24:32 -080028#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30#ifdef __KERNEL__
Alexey Dobriyanab611482005-07-12 12:08:43 -070031extern __be16 eth_type_trans(struct sk_buff *skb, struct net_device *dev);
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -070032extern const struct header_ops eth_header_ops;
33
34extern int eth_header(struct sk_buff *skb, struct net_device *dev,
35 unsigned short type,
36 const void *daddr, const void *saddr, unsigned len);
37extern int eth_rebuild_header(struct sk_buff *skb);
38extern int eth_header_parse(const struct sk_buff *skb, unsigned char *haddr);
David S. Millere69dd332011-07-12 23:28:12 -070039extern int eth_header_cache(const struct neighbour *neigh, struct hh_cache *hh, __be16 type);
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -070040extern void eth_header_cache_update(struct hh_cache *hh,
41 const struct net_device *dev,
42 const unsigned char *haddr);
Stefan Hajnoczifa0879e2013-01-21 01:17:22 +000043extern int eth_prepare_mac_addr_change(struct net_device *dev, void *p);
44extern void eth_commit_mac_addr_change(struct net_device *dev, void *p);
Stephen Hemmingerccad6372008-11-19 22:42:31 -080045extern int eth_mac_addr(struct net_device *dev, void *p);
46extern int eth_change_mtu(struct net_device *dev, int new_mtu);
47extern int eth_validate_addr(struct net_device *dev);
48
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -070049
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Tom Herbert36909ea2011-01-09 19:36:31 +000051extern struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs,
52 unsigned int rxqs);
Peter P Waskiewicz Jrf25f4e42007-07-06 13:36:20 -070053#define alloc_etherdev(sizeof_priv) alloc_etherdev_mq(sizeof_priv, 1)
Tom Herbert36909ea2011-01-09 19:36:31 +000054#define alloc_etherdev_mq(sizeof_priv, count) alloc_etherdev_mqs(sizeof_priv, count, count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
John Fastabendb3343a22012-09-18 00:01:12 +000056/* Reserved Ethernet Addresses per IEEE 802.1Q */
Ben Hutchings2bc80052012-11-01 09:12:02 +000057static const u8 eth_reserved_addr_base[ETH_ALEN] __aligned(2) =
58{ 0x01, 0x80, 0xc2, 0x00, 0x00, 0x00 };
John Fastabendb3343a22012-09-18 00:01:12 +000059
60/**
Ben Hutchings46acc462012-11-01 09:11:11 +000061 * is_link_local_ether_addr - Determine if given Ethernet address is link-local
John Fastabendb3343a22012-09-18 00:01:12 +000062 * @addr: Pointer to a six-byte array containing the Ethernet address
63 *
64 * Return true if address is link local reserved addr (01:80:c2:00:00:0X) per
65 * IEEE 802.1Q 8.6.3 Frame filtering.
66 */
Ben Hutchings46acc462012-11-01 09:11:11 +000067static inline bool is_link_local_ether_addr(const u8 *addr)
John Fastabendb3343a22012-09-18 00:01:12 +000068{
Ben Hutchings46acc462012-11-01 09:11:11 +000069 __be16 *a = (__be16 *)addr;
Ben Hutchings2bc80052012-11-01 09:12:02 +000070 static const __be16 *b = (const __be16 *)eth_reserved_addr_base;
John Fastabendb3343a22012-09-18 00:01:12 +000071 static const __be16 m = cpu_to_be16(0xfff0);
72
73 return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | ((a[2] ^ b[2]) & m)) == 0;
74}
75
Linus Torvalds1da177e2005-04-16 15:20:36 -070076/**
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080077 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
78 * @addr: Pointer to a six-byte array containing the Ethernet address
79 *
80 * Return true if the address is all zeroes.
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 */
Joe Perchesb44907e2012-05-08 06:44:40 +000082static inline bool is_zero_ether_addr(const u8 *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070083{
84 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
85}
86
87/**
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080088 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
Michael Ellerman791651212005-05-29 20:24:30 -070089 * @addr: Pointer to a six-byte array containing the Ethernet address
90 *
91 * Return true if the address is a multicast address.
Stephen Hemminger88df8ef2006-01-03 15:25:45 -080092 * By definition the broadcast address is also a multicast address.
Michael Ellerman791651212005-05-29 20:24:30 -070093 */
Joe Perchesb44907e2012-05-08 06:44:40 +000094static inline bool is_multicast_ether_addr(const u8 *addr)
Michael Ellerman791651212005-05-29 20:24:30 -070095{
Eric Dumazeta02cec22010-09-22 20:43:57 +000096 return 0x01 & addr[0];
Michael Ellerman791651212005-05-29 20:24:30 -070097}
98
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080099/**
Randy Dunlapbc2cda12008-02-13 15:03:25 -0800100 * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802).
Paolo 'Blaisorblade' Giarrussoe0247152007-05-06 14:51:13 -0700101 * @addr: Pointer to a six-byte array containing the Ethernet address
102 *
103 * Return true if the address is a local address.
104 */
Joe Perchesb44907e2012-05-08 06:44:40 +0000105static inline bool is_local_ether_addr(const u8 *addr)
Paolo 'Blaisorblade' Giarrussoe0247152007-05-06 14:51:13 -0700106{
Eric Dumazeta02cec22010-09-22 20:43:57 +0000107 return 0x02 & addr[0];
Paolo 'Blaisorblade' Giarrussoe0247152007-05-06 14:51:13 -0700108}
109
110/**
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -0800111 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
112 * @addr: Pointer to a six-byte array containing the Ethernet address
113 *
114 * Return true if the address is the broadcast address.
115 */
Joe Perchesb44907e2012-05-08 06:44:40 +0000116static inline bool is_broadcast_ether_addr(const u8 *addr)
Jeff Garzik9bd481f2005-06-28 01:46:35 -0400117{
Stephen Hemminger24075342005-11-01 16:52:11 -0800118 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
Jeff Garzik9bd481f2005-06-28 01:46:35 -0400119}
120
Michael Ellerman791651212005-05-29 20:24:30 -0700121/**
Tobias Klauser51e7eed72011-01-12 22:14:56 +0000122 * is_unicast_ether_addr - Determine if the Ethernet address is unicast
123 * @addr: Pointer to a six-byte array containing the Ethernet address
124 *
125 * Return true if the address is a unicast address.
126 */
Joe Perchesb44907e2012-05-08 06:44:40 +0000127static inline bool is_unicast_ether_addr(const u8 *addr)
Tobias Klauser51e7eed72011-01-12 22:14:56 +0000128{
129 return !is_multicast_ether_addr(addr);
130}
131
132/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 * is_valid_ether_addr - Determine if the given Ethernet address is valid
134 * @addr: Pointer to a six-byte array containing the Ethernet address
135 *
136 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
Michael Ellerman791651212005-05-29 20:24:30 -0700137 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 *
139 * Return true if the address is valid.
140 */
Joe Perchesb44907e2012-05-08 06:44:40 +0000141static inline bool is_valid_ether_addr(const u8 *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142{
Michael Ellerman791651212005-05-29 20:24:30 -0700143 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
144 * explicitly check for it here. */
145 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146}
147
148/**
Joe Perches0a4dd592012-07-12 19:33:05 +0000149 * eth_random_addr - Generate software assigned random Ethernet address
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * @addr: Pointer to a six-byte array containing the Ethernet address
151 *
152 * Generate a random Ethernet address (MAC) that is not multicast
153 * and has the local assigned bit set.
154 */
Joe Perches0a4dd592012-07-12 19:33:05 +0000155static inline void eth_random_addr(u8 *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156{
Joe Perches0a4dd592012-07-12 19:33:05 +0000157 get_random_bytes(addr, ETH_ALEN);
158 addr[0] &= 0xfe; /* clear multicast bit */
159 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160}
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700161
Joe Perches0a4dd592012-07-12 19:33:05 +0000162#define random_ether_addr(addr) eth_random_addr(addr)
163
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700164/**
Johannes Bergad7eee92012-07-10 06:18:44 +0000165 * eth_broadcast_addr - Assign broadcast address
166 * @addr: Pointer to a six-byte array containing the Ethernet address
167 *
168 * Assign the broadcast address to the given address array.
169 */
170static inline void eth_broadcast_addr(u8 *addr)
171{
172 memset(addr, 0xff, ETH_ALEN);
173}
174
175/**
Duan Jiong6d57e902012-09-08 16:32:28 +0000176 * eth_zero_addr - Assign zero address
177 * @addr: Pointer to a six-byte array containing the Ethernet address
178 *
179 * Assign the zero address to the given address array.
180 */
181static inline void eth_zero_addr(u8 *addr)
182{
183 memset(addr, 0x00, ETH_ALEN);
184}
185
186/**
Danny Kukawka1a0d6ae2012-02-09 09:48:54 +0000187 * eth_hw_addr_random - Generate software assigned random Ethernet and
188 * set device flag
Stefan Assmannc1f79422010-07-22 02:50:21 +0000189 * @dev: pointer to net_device structure
Stefan Assmannc1f79422010-07-22 02:50:21 +0000190 *
Danny Kukawka1a0d6ae2012-02-09 09:48:54 +0000191 * Generate a random Ethernet address (MAC) to be used by a net device
192 * and set addr_assign_type so the state can be read by sysfs and be
193 * used by userspace.
Stefan Assmannc1f79422010-07-22 02:50:21 +0000194 */
Danny Kukawka1a0d6ae2012-02-09 09:48:54 +0000195static inline void eth_hw_addr_random(struct net_device *dev)
Stefan Assmannc1f79422010-07-22 02:50:21 +0000196{
Jiri Pirkoe41b2d72013-01-01 03:30:15 +0000197 dev->addr_assign_type = NET_ADDR_RANDOM;
Joe Perches0a4dd592012-07-12 19:33:05 +0000198 eth_random_addr(dev->dev_addr);
Stefan Assmannc1f79422010-07-22 02:50:21 +0000199}
200
201/**
Bjørn Mork83a093b2013-08-30 18:08:44 +0200202 * eth_hw_addr_inherit - Copy dev_addr from another net_device
203 * @dst: pointer to net_device to copy dev_addr to
204 * @src: pointer to net_device to copy dev_addr from
205 *
206 * Copy the Ethernet address from one net_device to another along with
207 * the address attributes (addr_assign_type).
208 */
209static inline void eth_hw_addr_inherit(struct net_device *dst,
210 struct net_device *src)
211{
212 dst->addr_assign_type = src->addr_assign_type;
213 memcpy(dst->dev_addr, src->dev_addr, ETH_ALEN);
214}
215
216/**
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700217 * compare_ether_addr - Compare two Ethernet addresses
218 * @addr1: Pointer to a six-byte array containing the Ethernet address
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -0800219 * @addr2: Pointer other six-byte array containing the Ethernet address
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700220 *
stephen hemminger048b8992012-05-17 05:17:28 +0000221 * Compare two Ethernet addresses, returns 0 if equal, non-zero otherwise.
Johannes Berg1c430a72012-05-07 15:39:06 +0200222 * Unlike memcmp(), it doesn't return a value suitable for sorting.
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700223 */
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -0800224static inline unsigned compare_ether_addr(const u8 *addr1, const u8 *addr2)
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700225{
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -0800226 const u16 *a = (const u16 *) addr1;
227 const u16 *b = (const u16 *) addr2;
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700228
229 BUILD_BUG_ON(ETH_ALEN != 6);
230 return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) != 0;
231}
Eric Dumazet1f87e232008-11-23 23:24:32 -0800232
Joe Perchesa599b0f2012-05-08 18:56:45 +0000233/**
234 * ether_addr_equal - Compare two Ethernet addresses
235 * @addr1: Pointer to a six-byte array containing the Ethernet address
236 * @addr2: Pointer other six-byte array containing the Ethernet address
237 *
stephen hemminger048b8992012-05-17 05:17:28 +0000238 * Compare two Ethernet addresses, returns true if equal
Joe Perchesa599b0f2012-05-08 18:56:45 +0000239 */
240static inline bool ether_addr_equal(const u8 *addr1, const u8 *addr2)
241{
242 return !compare_ether_addr(addr1, addr2);
243}
244
Eric Dumazet1f87e232008-11-23 23:24:32 -0800245static inline unsigned long zap_last_2bytes(unsigned long value)
246{
247#ifdef __BIG_ENDIAN
248 return value >> 16;
249#else
250 return value << 16;
251#endif
252}
253
254/**
Joe Perchesbaf523c2012-05-09 17:04:03 +0000255 * ether_addr_equal_64bits - Compare two Ethernet addresses
256 * @addr1: Pointer to an array of 8 bytes
257 * @addr2: Pointer to an other array of 8 bytes
258 *
stephen hemminger048b8992012-05-17 05:17:28 +0000259 * Compare two Ethernet addresses, returns true if equal, false otherwise.
Joe Perchesbaf523c2012-05-09 17:04:03 +0000260 *
261 * The function doesn't need any conditional branches and possibly uses
262 * word memory accesses on CPU allowing cheap unaligned memory reads.
stephen hemminger048b8992012-05-17 05:17:28 +0000263 * arrays = { byte1, byte2, byte3, byte4, byte5, byte6, pad1, pad2 }
Joe Perchesbaf523c2012-05-09 17:04:03 +0000264 *
stephen hemminger048b8992012-05-17 05:17:28 +0000265 * Please note that alignment of addr1 & addr2 are only guaranteed to be 16 bits.
Joe Perchesbaf523c2012-05-09 17:04:03 +0000266 */
267
268static inline bool ether_addr_equal_64bits(const u8 addr1[6+2],
269 const u8 addr2[6+2])
270{
Joe Perchese550ba12012-05-11 12:21:06 +0000271#ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
272 unsigned long fold = ((*(unsigned long *)addr1) ^
273 (*(unsigned long *)addr2));
274
275 if (sizeof(fold) == 8)
276 return zap_last_2bytes(fold) == 0;
277
278 fold |= zap_last_2bytes((*(unsigned long *)(addr1 + 4)) ^
279 (*(unsigned long *)(addr2 + 4)));
280 return fold == 0;
281#else
282 return ether_addr_equal(addr1, addr2);
283#endif
Joe Perchesbaf523c2012-05-09 17:04:03 +0000284}
285
286/**
Jiri Pirkof001fde2009-05-05 02:48:28 +0000287 * is_etherdev_addr - Tell if given Ethernet address belongs to the device.
288 * @dev: Pointer to a device structure
289 * @addr: Pointer to a six-byte array containing the Ethernet address
290 *
291 * Compare passed address with all addresses of the device. Return true if the
292 * address if one of the device addresses.
293 *
Joe Perchese550ba12012-05-11 12:21:06 +0000294 * Note that this function calls ether_addr_equal_64bits() so take care of
Jiri Pirkof001fde2009-05-05 02:48:28 +0000295 * the right padding.
296 */
297static inline bool is_etherdev_addr(const struct net_device *dev,
298 const u8 addr[6 + 2])
299{
300 struct netdev_hw_addr *ha;
Joe Perchese550ba12012-05-11 12:21:06 +0000301 bool res = false;
Jiri Pirkof001fde2009-05-05 02:48:28 +0000302
303 rcu_read_lock();
304 for_each_dev_addr(dev, ha) {
Joe Perchese550ba12012-05-11 12:21:06 +0000305 res = ether_addr_equal_64bits(addr, ha->addr);
306 if (res)
Jiri Pirkof001fde2009-05-05 02:48:28 +0000307 break;
308 }
309 rcu_read_unlock();
Joe Perchese550ba12012-05-11 12:21:06 +0000310 return res;
Jiri Pirkof001fde2009-05-05 02:48:28 +0000311}
Michael Ellerman791651212005-05-29 20:24:30 -0700312#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000314/**
315 * compare_ether_header - Compare two Ethernet headers
316 * @a: Pointer to Ethernet header
317 * @b: Pointer to Ethernet header
318 *
stephen hemminger048b8992012-05-17 05:17:28 +0000319 * Compare two Ethernet headers, returns 0 if equal.
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000320 * This assumes that the network header (i.e., IP header) is 4-byte
321 * aligned OR the platform can handle unaligned access. This is the
322 * case for all packets coming into netif_receive_skb or similar
323 * entry points.
324 */
325
Eric Dumazet40d08022010-08-26 22:03:08 -0700326static inline unsigned long compare_ether_header(const void *a, const void *b)
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000327{
Eric Dumazet40d08022010-08-26 22:03:08 -0700328#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
329 unsigned long fold;
330
331 /*
332 * We want to compare 14 bytes:
333 * [a0 ... a13] ^ [b0 ... b13]
334 * Use two long XOR, ORed together, with an overlap of two bytes.
335 * [a0 a1 a2 a3 a4 a5 a6 a7 ] ^ [b0 b1 b2 b3 b4 b5 b6 b7 ] |
336 * [a6 a7 a8 a9 a10 a11 a12 a13] ^ [b6 b7 b8 b9 b10 b11 b12 b13]
337 * This means the [a6 a7] ^ [b6 b7] part is done two times.
338 */
339 fold = *(unsigned long *)a ^ *(unsigned long *)b;
340 fold |= *(unsigned long *)(a + 6) ^ *(unsigned long *)(b + 6);
341 return fold;
342#else
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000343 u32 *a32 = (u32 *)((u8 *)a + 2);
344 u32 *b32 = (u32 *)((u8 *)b + 2);
345
346 return (*(u16 *)a ^ *(u16 *)b) | (a32[0] ^ b32[0]) |
347 (a32[1] ^ b32[1]) | (a32[2] ^ b32[2]);
Eric Dumazet40d08022010-08-26 22:03:08 -0700348#endif
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000349}
350
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351#endif /* _LINUX_ETHERDEVICE_H */