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.
6 * Definitions for the Ethernet handlers.
8 * Version: @(#)eth.h 1.0.4 05/13/93
11 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
13 * Relocated to include/linux where it belongs by Alan Cox
14 * <gw4pts@gw4pts.ampr.org>
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.
22 #ifndef _LINUX_ETHERDEVICE_H
23 #define _LINUX_ETHERDEVICE_H
25 #include <linux/if_ether.h>
26 #include <linux/netdevice.h>
27 #include <linux/random.h>
28 #include <asm/unaligned.h>
29 #include <asm/bitsperlong.h>
32 __be16 eth_type_trans(struct sk_buff *skb, struct net_device *dev);
33 extern const struct header_ops eth_header_ops;
35 int eth_header(struct sk_buff *skb, struct net_device *dev, unsigned short type,
36 const void *daddr, const void *saddr, unsigned len);
37 int eth_rebuild_header(struct sk_buff *skb);
38 int eth_header_parse(const struct sk_buff *skb, unsigned char *haddr);
39 int eth_header_cache(const struct neighbour *neigh, struct hh_cache *hh,
41 void eth_header_cache_update(struct hh_cache *hh, const struct net_device *dev,
42 const unsigned char *haddr);
43 int eth_prepare_mac_addr_change(struct net_device *dev, void *p);
44 void eth_commit_mac_addr_change(struct net_device *dev, void *p);
45 int eth_mac_addr(struct net_device *dev, void *p);
46 int eth_change_mtu(struct net_device *dev, int new_mtu);
47 int eth_validate_addr(struct net_device *dev);
49 struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs,
51 #define alloc_etherdev(sizeof_priv) alloc_etherdev_mq(sizeof_priv, 1)
52 #define alloc_etherdev_mq(sizeof_priv, count) alloc_etherdev_mqs(sizeof_priv, count, count)
54 /* Reserved Ethernet Addresses per IEEE 802.1Q */
55 static const u8 eth_reserved_addr_base[ETH_ALEN] __aligned(2) =
56 { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x00 };
59 * is_link_local_ether_addr - Determine if given Ethernet address is link-local
60 * @addr: Pointer to a six-byte array containing the Ethernet address
62 * Return true if address is link local reserved addr (01:80:c2:00:00:0X) per
63 * IEEE 802.1Q 8.6.3 Frame filtering.
65 * Please note: addr must be aligned to u16.
67 static inline bool is_link_local_ether_addr(const u8 *addr)
69 __be16 *a = (__be16 *)addr;
70 static const __be16 *b = (const __be16 *)eth_reserved_addr_base;
71 static const __be16 m = cpu_to_be16(0xfff0);
73 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
74 return (((*(const u32 *)addr) ^ (*(const u32 *)b)) |
75 ((a[2] ^ b[2]) & m)) == 0;
77 return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | ((a[2] ^ b[2]) & m)) == 0;
82 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
83 * @addr: Pointer to a six-byte array containing the Ethernet address
85 * Return true if the address is all zeroes.
87 * Please note: addr must be aligned to u16.
89 static inline bool is_zero_ether_addr(const u8 *addr)
91 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
92 return ((*(const u32 *)addr) | (*(const u16 *)(addr + 4))) == 0;
94 return (*(const u16 *)(addr + 0) |
95 *(const u16 *)(addr + 2) |
96 *(const u16 *)(addr + 4)) == 0;
101 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
102 * @addr: Pointer to a six-byte array containing the Ethernet address
104 * Return true if the address is a multicast address.
105 * By definition the broadcast address is also a multicast address.
107 static inline bool is_multicast_ether_addr(const u8 *addr)
109 return 0x01 & addr[0];
113 * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802).
114 * @addr: Pointer to a six-byte array containing the Ethernet address
116 * Return true if the address is a local address.
118 static inline bool is_local_ether_addr(const u8 *addr)
120 return 0x02 & addr[0];
124 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
125 * @addr: Pointer to a six-byte array containing the Ethernet address
127 * Return true if the address is the broadcast address.
129 * Please note: addr must be aligned to u16.
131 static inline bool is_broadcast_ether_addr(const u8 *addr)
133 return (*(const u16 *)(addr + 0) &
134 *(const u16 *)(addr + 2) &
135 *(const u16 *)(addr + 4)) == 0xffff;
139 * is_unicast_ether_addr - Determine if the Ethernet address is unicast
140 * @addr: Pointer to a six-byte array containing the Ethernet address
142 * Return true if the address is a unicast address.
144 static inline bool is_unicast_ether_addr(const u8 *addr)
146 return !is_multicast_ether_addr(addr);
150 * is_valid_ether_addr - Determine if the given Ethernet address is valid
151 * @addr: Pointer to a six-byte array containing the Ethernet address
153 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
154 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
156 * Return true if the address is valid.
158 * Please note: addr must be aligned to u16.
160 static inline bool is_valid_ether_addr(const u8 *addr)
162 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
163 * explicitly check for it here. */
164 return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
168 * eth_random_addr - Generate software assigned random Ethernet address
169 * @addr: Pointer to a six-byte array containing the Ethernet address
171 * Generate a random Ethernet address (MAC) that is not multicast
172 * and has the local assigned bit set.
174 static inline void eth_random_addr(u8 *addr)
176 get_random_bytes(addr, ETH_ALEN);
177 addr[0] &= 0xfe; /* clear multicast bit */
178 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
181 #define random_ether_addr(addr) eth_random_addr(addr)
184 * eth_broadcast_addr - Assign broadcast address
185 * @addr: Pointer to a six-byte array containing the Ethernet address
187 * Assign the broadcast address to the given address array.
189 static inline void eth_broadcast_addr(u8 *addr)
191 memset(addr, 0xff, ETH_ALEN);
195 * eth_zero_addr - Assign zero address
196 * @addr: Pointer to a six-byte array containing the Ethernet address
198 * Assign the zero address to the given address array.
200 static inline void eth_zero_addr(u8 *addr)
202 memset(addr, 0x00, ETH_ALEN);
206 * eth_hw_addr_random - Generate software assigned random Ethernet and
208 * @dev: pointer to net_device structure
210 * Generate a random Ethernet address (MAC) to be used by a net device
211 * and set addr_assign_type so the state can be read by sysfs and be
214 static inline void eth_hw_addr_random(struct net_device *dev)
216 dev->addr_assign_type = NET_ADDR_RANDOM;
217 eth_random_addr(dev->dev_addr);
221 * eth_hw_addr_inherit - Copy dev_addr from another net_device
222 * @dst: pointer to net_device to copy dev_addr to
223 * @src: pointer to net_device to copy dev_addr from
225 * Copy the Ethernet address from one net_device to another along with
226 * the address attributes (addr_assign_type).
228 static inline void eth_hw_addr_inherit(struct net_device *dst,
229 struct net_device *src)
231 dst->addr_assign_type = src->addr_assign_type;
232 memcpy(dst->dev_addr, src->dev_addr, ETH_ALEN);
236 * ether_addr_equal - Compare two Ethernet addresses
237 * @addr1: Pointer to a six-byte array containing the Ethernet address
238 * @addr2: Pointer other six-byte array containing the Ethernet address
240 * Compare two Ethernet addresses, returns true if equal
242 * Please note: addr1 & addr2 must both be aligned to u16.
244 static inline bool ether_addr_equal(const u8 *addr1, const u8 *addr2)
246 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
247 u32 fold = ((*(const u32 *)addr1) ^ (*(const u32 *)addr2)) |
248 ((*(const u16 *)(addr1 + 4)) ^ (*(const u16 *)(addr2 + 4)));
252 const u16 *a = (const u16 *)addr1;
253 const u16 *b = (const u16 *)addr2;
255 return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) == 0;
260 * ether_addr_equal_64bits - Compare two Ethernet addresses
261 * @addr1: Pointer to an array of 8 bytes
262 * @addr2: Pointer to an other array of 8 bytes
264 * Compare two Ethernet addresses, returns true if equal, false otherwise.
266 * The function doesn't need any conditional branches and possibly uses
267 * word memory accesses on CPU allowing cheap unaligned memory reads.
268 * arrays = { byte1, byte2, byte3, byte4, byte5, byte6, pad1, pad2 }
270 * Please note that alignment of addr1 & addr2 are only guaranteed to be 16 bits.
273 static inline bool ether_addr_equal_64bits(const u8 addr1[6+2],
276 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
277 u64 fold = (*(const u64 *)addr1) ^ (*(const u64 *)addr2);
280 return (fold >> 16) == 0;
282 return (fold << 16) == 0;
285 return ether_addr_equal(addr1, addr2);
290 * ether_addr_equal_unaligned - Compare two not u16 aligned Ethernet addresses
291 * @addr1: Pointer to a six-byte array containing the Ethernet address
292 * @addr2: Pointer other six-byte array containing the Ethernet address
294 * Compare two Ethernet addresses, returns true if equal
296 * Please note: Use only when any Ethernet address may not be u16 aligned.
298 static inline bool ether_addr_equal_unaligned(const u8 *addr1, const u8 *addr2)
300 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
301 return ether_addr_equal(addr1, addr2);
303 return memcmp(addr1, addr2, ETH_ALEN) == 0;
308 * is_etherdev_addr - Tell if given Ethernet address belongs to the device.
309 * @dev: Pointer to a device structure
310 * @addr: Pointer to a six-byte array containing the Ethernet address
312 * Compare passed address with all addresses of the device. Return true if the
313 * address if one of the device addresses.
315 * Note that this function calls ether_addr_equal_64bits() so take care of
318 static inline bool is_etherdev_addr(const struct net_device *dev,
319 const u8 addr[6 + 2])
321 struct netdev_hw_addr *ha;
325 for_each_dev_addr(dev, ha) {
326 res = ether_addr_equal_64bits(addr, ha->addr);
333 #endif /* __KERNEL__ */
336 * compare_ether_header - Compare two Ethernet headers
337 * @a: Pointer to Ethernet header
338 * @b: Pointer to Ethernet header
340 * Compare two Ethernet headers, returns 0 if equal.
341 * This assumes that the network header (i.e., IP header) is 4-byte
342 * aligned OR the platform can handle unaligned access. This is the
343 * case for all packets coming into netif_receive_skb or similar
347 static inline unsigned long compare_ether_header(const void *a, const void *b)
349 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
353 * We want to compare 14 bytes:
354 * [a0 ... a13] ^ [b0 ... b13]
355 * Use two long XOR, ORed together, with an overlap of two bytes.
356 * [a0 a1 a2 a3 a4 a5 a6 a7 ] ^ [b0 b1 b2 b3 b4 b5 b6 b7 ] |
357 * [a6 a7 a8 a9 a10 a11 a12 a13] ^ [b6 b7 b8 b9 b10 b11 b12 b13]
358 * This means the [a6 a7] ^ [b6 b7] part is done two times.
360 fold = *(unsigned long *)a ^ *(unsigned long *)b;
361 fold |= *(unsigned long *)(a + 6) ^ *(unsigned long *)(b + 6);
364 u32 *a32 = (u32 *)((u8 *)a + 2);
365 u32 *b32 = (u32 *)((u8 *)b + 2);
367 return (*(u16 *)a ^ *(u16 *)b) | (a32[0] ^ b32[0]) |
368 (a32[1] ^ b32[1]) | (a32[2] ^ b32[2]);
372 #endif /* _LINUX_ETHERDEVICE_H */