Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 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 Juhl | 02c30a8 | 2005-05-05 16:16:16 -0700 | [diff] [blame] | 10 | * Authors: Ross Biro |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 11 | * 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 | * |
| 21 | * WARNING: This move may well be temporary. This file will get merged with others RSN. |
| 22 | * |
| 23 | */ |
| 24 | #ifndef _LINUX_ETHERDEVICE_H |
| 25 | #define _LINUX_ETHERDEVICE_H |
| 26 | |
| 27 | #include <linux/if_ether.h> |
Arnd Bergmann | bcd6127 | 2005-06-28 15:58:50 -0700 | [diff] [blame] | 28 | #include <linux/netdevice.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 29 | #include <linux/random.h> |
Eric Dumazet | 1f87e23 | 2008-11-23 23:24:32 -0800 | [diff] [blame] | 30 | #include <asm/unaligned.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 31 | |
| 32 | #ifdef __KERNEL__ |
Alexey Dobriyan | ab61148 | 2005-07-12 12:08:43 -0700 | [diff] [blame] | 33 | extern __be16 eth_type_trans(struct sk_buff *skb, struct net_device *dev); |
Stephen Hemminger | 3b04ddd | 2007-10-09 01:40:57 -0700 | [diff] [blame] | 34 | extern const struct header_ops eth_header_ops; |
| 35 | |
| 36 | extern int eth_header(struct sk_buff *skb, struct net_device *dev, |
| 37 | unsigned short type, |
| 38 | const void *daddr, const void *saddr, unsigned len); |
| 39 | extern int eth_rebuild_header(struct sk_buff *skb); |
| 40 | extern int eth_header_parse(const struct sk_buff *skb, unsigned char *haddr); |
David S. Miller | e69dd33 | 2011-07-12 23:28:12 -0700 | [diff] [blame] | 41 | extern int eth_header_cache(const struct neighbour *neigh, struct hh_cache *hh, __be16 type); |
Stephen Hemminger | 3b04ddd | 2007-10-09 01:40:57 -0700 | [diff] [blame] | 42 | extern void eth_header_cache_update(struct hh_cache *hh, |
| 43 | const struct net_device *dev, |
| 44 | const unsigned char *haddr); |
Stephen Hemminger | ccad637 | 2008-11-19 22:42:31 -0800 | [diff] [blame] | 45 | extern int eth_mac_addr(struct net_device *dev, void *p); |
| 46 | extern int eth_change_mtu(struct net_device *dev, int new_mtu); |
| 47 | extern int eth_validate_addr(struct net_device *dev); |
| 48 | |
Stephen Hemminger | 3b04ddd | 2007-10-09 01:40:57 -0700 | [diff] [blame] | 49 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | |
Tom Herbert | 36909ea | 2011-01-09 19:36:31 +0000 | [diff] [blame] | 51 | extern struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs, |
| 52 | unsigned int rxqs); |
Peter P Waskiewicz Jr | f25f4e4 | 2007-07-06 13:36:20 -0700 | [diff] [blame] | 53 | #define alloc_etherdev(sizeof_priv) alloc_etherdev_mq(sizeof_priv, 1) |
Tom Herbert | 36909ea | 2011-01-09 19:36:31 +0000 | [diff] [blame] | 54 | #define alloc_etherdev_mq(sizeof_priv, count) alloc_etherdev_mqs(sizeof_priv, count, count) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 55 | |
| 56 | /** |
Stephen Hemminger | c2da8ac | 2005-11-01 17:05:09 -0800 | [diff] [blame] | 57 | * is_zero_ether_addr - Determine if give Ethernet address is all zeros. |
| 58 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 59 | * |
| 60 | * Return true if the address is all zeroes. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 61 | */ |
| 62 | static inline int is_zero_ether_addr(const u8 *addr) |
| 63 | { |
| 64 | return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]); |
| 65 | } |
| 66 | |
| 67 | /** |
Stephen Hemminger | c2da8ac | 2005-11-01 17:05:09 -0800 | [diff] [blame] | 68 | * is_multicast_ether_addr - Determine if the Ethernet address is a multicast. |
Michael Ellerman | 79165121 | 2005-05-29 20:24:30 -0700 | [diff] [blame] | 69 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 70 | * |
| 71 | * Return true if the address is a multicast address. |
Stephen Hemminger | 88df8ef | 2006-01-03 15:25:45 -0800 | [diff] [blame] | 72 | * By definition the broadcast address is also a multicast address. |
Michael Ellerman | 79165121 | 2005-05-29 20:24:30 -0700 | [diff] [blame] | 73 | */ |
| 74 | static inline int is_multicast_ether_addr(const u8 *addr) |
| 75 | { |
Eric Dumazet | a02cec2 | 2010-09-22 20:43:57 +0000 | [diff] [blame] | 76 | return 0x01 & addr[0]; |
Michael Ellerman | 79165121 | 2005-05-29 20:24:30 -0700 | [diff] [blame] | 77 | } |
| 78 | |
Stephen Hemminger | c2da8ac | 2005-11-01 17:05:09 -0800 | [diff] [blame] | 79 | /** |
Randy Dunlap | bc2cda1 | 2008-02-13 15:03:25 -0800 | [diff] [blame] | 80 | * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802). |
Paolo 'Blaisorblade' Giarrusso | e024715 | 2007-05-06 14:51:13 -0700 | [diff] [blame] | 81 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 82 | * |
| 83 | * Return true if the address is a local address. |
| 84 | */ |
| 85 | static inline int is_local_ether_addr(const u8 *addr) |
| 86 | { |
Eric Dumazet | a02cec2 | 2010-09-22 20:43:57 +0000 | [diff] [blame] | 87 | return 0x02 & addr[0]; |
Paolo 'Blaisorblade' Giarrusso | e024715 | 2007-05-06 14:51:13 -0700 | [diff] [blame] | 88 | } |
| 89 | |
| 90 | /** |
Stephen Hemminger | c2da8ac | 2005-11-01 17:05:09 -0800 | [diff] [blame] | 91 | * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast |
| 92 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 93 | * |
| 94 | * Return true if the address is the broadcast address. |
| 95 | */ |
Jeff Garzik | 9bd481f | 2005-06-28 01:46:35 -0400 | [diff] [blame] | 96 | static inline int is_broadcast_ether_addr(const u8 *addr) |
| 97 | { |
Stephen Hemminger | 2407534 | 2005-11-01 16:52:11 -0800 | [diff] [blame] | 98 | return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff; |
Jeff Garzik | 9bd481f | 2005-06-28 01:46:35 -0400 | [diff] [blame] | 99 | } |
| 100 | |
Michael Ellerman | 79165121 | 2005-05-29 20:24:30 -0700 | [diff] [blame] | 101 | /** |
Tobias Klauser | 51e7eed7 | 2011-01-12 22:14:56 +0000 | [diff] [blame] | 102 | * is_unicast_ether_addr - Determine if the Ethernet address is unicast |
| 103 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 104 | * |
| 105 | * Return true if the address is a unicast address. |
| 106 | */ |
| 107 | static inline int is_unicast_ether_addr(const u8 *addr) |
| 108 | { |
| 109 | return !is_multicast_ether_addr(addr); |
| 110 | } |
| 111 | |
| 112 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | * is_valid_ether_addr - Determine if the given Ethernet address is valid |
| 114 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 115 | * |
| 116 | * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not |
Michael Ellerman | 79165121 | 2005-05-29 20:24:30 -0700 | [diff] [blame] | 117 | * a multicast address, and is not FF:FF:FF:FF:FF:FF. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 118 | * |
| 119 | * Return true if the address is valid. |
| 120 | */ |
| 121 | static inline int is_valid_ether_addr(const u8 *addr) |
| 122 | { |
Michael Ellerman | 79165121 | 2005-05-29 20:24:30 -0700 | [diff] [blame] | 123 | /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to |
| 124 | * explicitly check for it here. */ |
| 125 | return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 126 | } |
| 127 | |
| 128 | /** |
| 129 | * random_ether_addr - Generate software assigned random Ethernet address |
| 130 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 131 | * |
| 132 | * Generate a random Ethernet address (MAC) that is not multicast |
| 133 | * and has the local assigned bit set. |
| 134 | */ |
| 135 | static inline void random_ether_addr(u8 *addr) |
| 136 | { |
| 137 | get_random_bytes (addr, ETH_ALEN); |
| 138 | addr [0] &= 0xfe; /* clear multicast bit */ |
| 139 | addr [0] |= 0x02; /* set local assignment bit (IEEE802) */ |
| 140 | } |
Stephen Hemminger | 360ac8e | 2005-10-25 15:03:41 -0700 | [diff] [blame] | 141 | |
| 142 | /** |
Danny Kukawka | 1a0d6ae | 2012-02-09 09:48:54 +0000 | [diff] [blame] | 143 | * eth_hw_addr_random - Generate software assigned random Ethernet and |
| 144 | * set device flag |
Stefan Assmann | c1f7942 | 2010-07-22 02:50:21 +0000 | [diff] [blame] | 145 | * @dev: pointer to net_device structure |
Stefan Assmann | c1f7942 | 2010-07-22 02:50:21 +0000 | [diff] [blame] | 146 | * |
Danny Kukawka | 1a0d6ae | 2012-02-09 09:48:54 +0000 | [diff] [blame] | 147 | * Generate a random Ethernet address (MAC) to be used by a net device |
| 148 | * and set addr_assign_type so the state can be read by sysfs and be |
| 149 | * used by userspace. |
Stefan Assmann | c1f7942 | 2010-07-22 02:50:21 +0000 | [diff] [blame] | 150 | */ |
Danny Kukawka | 1a0d6ae | 2012-02-09 09:48:54 +0000 | [diff] [blame] | 151 | static inline void eth_hw_addr_random(struct net_device *dev) |
Stefan Assmann | c1f7942 | 2010-07-22 02:50:21 +0000 | [diff] [blame] | 152 | { |
| 153 | dev->addr_assign_type |= NET_ADDR_RANDOM; |
Danny Kukawka | 1a0d6ae | 2012-02-09 09:48:54 +0000 | [diff] [blame] | 154 | random_ether_addr(dev->dev_addr); |
Stefan Assmann | c1f7942 | 2010-07-22 02:50:21 +0000 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | /** |
Stephen Hemminger | 360ac8e | 2005-10-25 15:03:41 -0700 | [diff] [blame] | 158 | * compare_ether_addr - Compare two Ethernet addresses |
| 159 | * @addr1: Pointer to a six-byte array containing the Ethernet address |
Stephen Hemminger | c2da8ac | 2005-11-01 17:05:09 -0800 | [diff] [blame] | 160 | * @addr2: Pointer other six-byte array containing the Ethernet address |
Stephen Hemminger | 360ac8e | 2005-10-25 15:03:41 -0700 | [diff] [blame] | 161 | * |
Johannes Berg | 1c430a7 | 2012-05-07 15:39:06 +0200 | [diff] [blame^] | 162 | * Compare two ethernet addresses, returns 0 if equal, non-zero otherwise. |
| 163 | * Unlike memcmp(), it doesn't return a value suitable for sorting. |
Stephen Hemminger | 360ac8e | 2005-10-25 15:03:41 -0700 | [diff] [blame] | 164 | */ |
Stephen Hemminger | c2da8ac | 2005-11-01 17:05:09 -0800 | [diff] [blame] | 165 | static inline unsigned compare_ether_addr(const u8 *addr1, const u8 *addr2) |
Stephen Hemminger | 360ac8e | 2005-10-25 15:03:41 -0700 | [diff] [blame] | 166 | { |
Stephen Hemminger | c2da8ac | 2005-11-01 17:05:09 -0800 | [diff] [blame] | 167 | const u16 *a = (const u16 *) addr1; |
| 168 | const u16 *b = (const u16 *) addr2; |
Stephen Hemminger | 360ac8e | 2005-10-25 15:03:41 -0700 | [diff] [blame] | 169 | |
| 170 | BUILD_BUG_ON(ETH_ALEN != 6); |
| 171 | return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) != 0; |
| 172 | } |
Eric Dumazet | 1f87e23 | 2008-11-23 23:24:32 -0800 | [diff] [blame] | 173 | |
| 174 | static inline unsigned long zap_last_2bytes(unsigned long value) |
| 175 | { |
| 176 | #ifdef __BIG_ENDIAN |
| 177 | return value >> 16; |
| 178 | #else |
| 179 | return value << 16; |
| 180 | #endif |
| 181 | } |
| 182 | |
| 183 | /** |
| 184 | * compare_ether_addr_64bits - Compare two Ethernet addresses |
| 185 | * @addr1: Pointer to an array of 8 bytes |
| 186 | * @addr2: Pointer to an other array of 8 bytes |
| 187 | * |
Johannes Berg | 1c430a7 | 2012-05-07 15:39:06 +0200 | [diff] [blame^] | 188 | * Compare two ethernet addresses, returns 0 if equal, non-zero otherwise. |
| 189 | * Unlike memcmp(), it doesn't return a value suitable for sorting. |
| 190 | * The function doesn't need any conditional branches and possibly uses |
| 191 | * word memory accesses on CPU allowing cheap unaligned memory reads. |
Eric Dumazet | 1f87e23 | 2008-11-23 23:24:32 -0800 | [diff] [blame] | 192 | * arrays = { byte1, byte2, byte3, byte4, byte6, byte7, pad1, pad2} |
| 193 | * |
| 194 | * Please note that alignment of addr1 & addr2 is only guaranted to be 16 bits. |
| 195 | */ |
| 196 | |
| 197 | static inline unsigned compare_ether_addr_64bits(const u8 addr1[6+2], |
| 198 | const u8 addr2[6+2]) |
| 199 | { |
| 200 | #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS |
| 201 | unsigned long fold = ((*(unsigned long *)addr1) ^ |
| 202 | (*(unsigned long *)addr2)); |
| 203 | |
| 204 | if (sizeof(fold) == 8) |
| 205 | return zap_last_2bytes(fold) != 0; |
| 206 | |
| 207 | fold |= zap_last_2bytes((*(unsigned long *)(addr1 + 4)) ^ |
| 208 | (*(unsigned long *)(addr2 + 4))); |
| 209 | return fold != 0; |
| 210 | #else |
| 211 | return compare_ether_addr(addr1, addr2); |
| 212 | #endif |
| 213 | } |
Jiri Pirko | f001fde | 2009-05-05 02:48:28 +0000 | [diff] [blame] | 214 | |
| 215 | /** |
| 216 | * is_etherdev_addr - Tell if given Ethernet address belongs to the device. |
| 217 | * @dev: Pointer to a device structure |
| 218 | * @addr: Pointer to a six-byte array containing the Ethernet address |
| 219 | * |
| 220 | * Compare passed address with all addresses of the device. Return true if the |
| 221 | * address if one of the device addresses. |
| 222 | * |
| 223 | * Note that this function calls compare_ether_addr_64bits() so take care of |
| 224 | * the right padding. |
| 225 | */ |
| 226 | static inline bool is_etherdev_addr(const struct net_device *dev, |
| 227 | const u8 addr[6 + 2]) |
| 228 | { |
| 229 | struct netdev_hw_addr *ha; |
| 230 | int res = 1; |
| 231 | |
| 232 | rcu_read_lock(); |
| 233 | for_each_dev_addr(dev, ha) { |
| 234 | res = compare_ether_addr_64bits(addr, ha->addr); |
| 235 | if (!res) |
| 236 | break; |
| 237 | } |
| 238 | rcu_read_unlock(); |
| 239 | return !res; |
| 240 | } |
Michael Ellerman | 79165121 | 2005-05-29 20:24:30 -0700 | [diff] [blame] | 241 | #endif /* __KERNEL__ */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 242 | |
Herbert Xu | aa4b9f5 | 2009-02-08 18:00:37 +0000 | [diff] [blame] | 243 | /** |
| 244 | * compare_ether_header - Compare two Ethernet headers |
| 245 | * @a: Pointer to Ethernet header |
| 246 | * @b: Pointer to Ethernet header |
| 247 | * |
| 248 | * Compare two ethernet headers, returns 0 if equal. |
| 249 | * This assumes that the network header (i.e., IP header) is 4-byte |
| 250 | * aligned OR the platform can handle unaligned access. This is the |
| 251 | * case for all packets coming into netif_receive_skb or similar |
| 252 | * entry points. |
| 253 | */ |
| 254 | |
Eric Dumazet | 40d0802 | 2010-08-26 22:03:08 -0700 | [diff] [blame] | 255 | static inline unsigned long compare_ether_header(const void *a, const void *b) |
Herbert Xu | aa4b9f5 | 2009-02-08 18:00:37 +0000 | [diff] [blame] | 256 | { |
Eric Dumazet | 40d0802 | 2010-08-26 22:03:08 -0700 | [diff] [blame] | 257 | #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64 |
| 258 | unsigned long fold; |
| 259 | |
| 260 | /* |
| 261 | * We want to compare 14 bytes: |
| 262 | * [a0 ... a13] ^ [b0 ... b13] |
| 263 | * Use two long XOR, ORed together, with an overlap of two bytes. |
| 264 | * [a0 a1 a2 a3 a4 a5 a6 a7 ] ^ [b0 b1 b2 b3 b4 b5 b6 b7 ] | |
| 265 | * [a6 a7 a8 a9 a10 a11 a12 a13] ^ [b6 b7 b8 b9 b10 b11 b12 b13] |
| 266 | * This means the [a6 a7] ^ [b6 b7] part is done two times. |
| 267 | */ |
| 268 | fold = *(unsigned long *)a ^ *(unsigned long *)b; |
| 269 | fold |= *(unsigned long *)(a + 6) ^ *(unsigned long *)(b + 6); |
| 270 | return fold; |
| 271 | #else |
Herbert Xu | aa4b9f5 | 2009-02-08 18:00:37 +0000 | [diff] [blame] | 272 | u32 *a32 = (u32 *)((u8 *)a + 2); |
| 273 | u32 *b32 = (u32 *)((u8 *)b + 2); |
| 274 | |
| 275 | return (*(u16 *)a ^ *(u16 *)b) | (a32[0] ^ b32[0]) | |
| 276 | (a32[1] ^ b32[1]) | (a32[2] ^ b32[2]); |
Eric Dumazet | 40d0802 | 2010-08-26 22:03:08 -0700 | [diff] [blame] | 277 | #endif |
Herbert Xu | aa4b9f5 | 2009-02-08 18:00:37 +0000 | [diff] [blame] | 278 | } |
| 279 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 280 | #endif /* _LINUX_ETHERDEVICE_H */ |