Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | * | |
02c30a84 | 10 | * Authors: Ross Biro |
1da177e4 LT |
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> | |
bcd61272 | 28 | #include <linux/netdevice.h> |
1da177e4 | 29 | #include <linux/random.h> |
1f87e235 | 30 | #include <asm/unaligned.h> |
1da177e4 LT |
31 | |
32 | #ifdef __KERNEL__ | |
ab611487 | 33 | extern __be16 eth_type_trans(struct sk_buff *skb, struct net_device *dev); |
3b04ddde SH |
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); | |
e69dd336 | 41 | extern int eth_header_cache(const struct neighbour *neigh, struct hh_cache *hh, __be16 type); |
3b04ddde SH |
42 | extern void eth_header_cache_update(struct hh_cache *hh, |
43 | const struct net_device *dev, | |
44 | const unsigned char *haddr); | |
ccad637b SH |
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 | ||
3b04ddde | 49 | |
1da177e4 | 50 | |
36909ea4 TH |
51 | extern struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs, |
52 | unsigned int rxqs); | |
f25f4e44 | 53 | #define alloc_etherdev(sizeof_priv) alloc_etherdev_mq(sizeof_priv, 1) |
36909ea4 | 54 | #define alloc_etherdev_mq(sizeof_priv, count) alloc_etherdev_mqs(sizeof_priv, count, count) |
1da177e4 LT |
55 | |
56 | /** | |
c2da8aca SH |
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. | |
1da177e4 LT |
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 | ||
79165121 | 67 | /** |
c2da8aca | 68 | * is_multicast_ether_addr - Determine if the Ethernet address is a multicast. |
79165121 ME |
69 | * @addr: Pointer to a six-byte array containing the Ethernet address |
70 | * | |
71 | * Return true if the address is a multicast address. | |
88df8ef5 | 72 | * By definition the broadcast address is also a multicast address. |
79165121 ME |
73 | */ |
74 | static inline int is_multicast_ether_addr(const u8 *addr) | |
75 | { | |
a02cec21 | 76 | return 0x01 & addr[0]; |
79165121 ME |
77 | } |
78 | ||
e024715f | 79 | /** |
bc2cda1e | 80 | * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802). |
e024715f PBG |
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 | { | |
a02cec21 | 87 | return 0x02 & addr[0]; |
e024715f PBG |
88 | } |
89 | ||
c2da8aca SH |
90 | /** |
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 | */ | |
9bd481f8 JG |
96 | static inline int is_broadcast_ether_addr(const u8 *addr) |
97 | { | |
2407534f | 98 | return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff; |
9bd481f8 JG |
99 | } |
100 | ||
51e7eed7 TK |
101 | /** |
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 | ||
1da177e4 LT |
112 | /** |
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 | |
79165121 | 117 | * a multicast address, and is not FF:FF:FF:FF:FF:FF. |
1da177e4 LT |
118 | * |
119 | * Return true if the address is valid. | |
120 | */ | |
121 | static inline int is_valid_ether_addr(const u8 *addr) | |
122 | { | |
79165121 ME |
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); | |
1da177e4 LT |
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 | } | |
360ac8e2 | 141 | |
c1f79426 | 142 | /** |
1a0d6ae5 DK |
143 | * eth_hw_addr_random - Generate software assigned random Ethernet and |
144 | * set device flag | |
c1f79426 | 145 | * @dev: pointer to net_device structure |
c1f79426 | 146 | * |
1a0d6ae5 DK |
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. | |
c1f79426 | 150 | */ |
1a0d6ae5 | 151 | static inline void eth_hw_addr_random(struct net_device *dev) |
c1f79426 SA |
152 | { |
153 | dev->addr_assign_type |= NET_ADDR_RANDOM; | |
1a0d6ae5 | 154 | random_ether_addr(dev->dev_addr); |
c1f79426 SA |
155 | } |
156 | ||
360ac8e2 SH |
157 | /** |
158 | * compare_ether_addr - Compare two Ethernet addresses | |
159 | * @addr1: Pointer to a six-byte array containing the Ethernet address | |
c2da8aca | 160 | * @addr2: Pointer other six-byte array containing the Ethernet address |
360ac8e2 SH |
161 | * |
162 | * Compare two ethernet addresses, returns 0 if equal | |
163 | */ | |
c2da8aca | 164 | static inline unsigned compare_ether_addr(const u8 *addr1, const u8 *addr2) |
360ac8e2 | 165 | { |
c2da8aca SH |
166 | const u16 *a = (const u16 *) addr1; |
167 | const u16 *b = (const u16 *) addr2; | |
360ac8e2 SH |
168 | |
169 | BUILD_BUG_ON(ETH_ALEN != 6); | |
170 | return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) != 0; | |
171 | } | |
1f87e235 ED |
172 | |
173 | static inline unsigned long zap_last_2bytes(unsigned long value) | |
174 | { | |
175 | #ifdef __BIG_ENDIAN | |
176 | return value >> 16; | |
177 | #else | |
178 | return value << 16; | |
179 | #endif | |
180 | } | |
181 | ||
182 | /** | |
183 | * compare_ether_addr_64bits - Compare two Ethernet addresses | |
184 | * @addr1: Pointer to an array of 8 bytes | |
185 | * @addr2: Pointer to an other array of 8 bytes | |
186 | * | |
187 | * Compare two ethernet addresses, returns 0 if equal. | |
188 | * Same result than "memcmp(addr1, addr2, ETH_ALEN)" but without conditional | |
189 | * branches, and possibly long word memory accesses on CPU allowing cheap | |
190 | * unaligned memory reads. | |
191 | * arrays = { byte1, byte2, byte3, byte4, byte6, byte7, pad1, pad2} | |
192 | * | |
193 | * Please note that alignment of addr1 & addr2 is only guaranted to be 16 bits. | |
194 | */ | |
195 | ||
196 | static inline unsigned compare_ether_addr_64bits(const u8 addr1[6+2], | |
197 | const u8 addr2[6+2]) | |
198 | { | |
199 | #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS | |
200 | unsigned long fold = ((*(unsigned long *)addr1) ^ | |
201 | (*(unsigned long *)addr2)); | |
202 | ||
203 | if (sizeof(fold) == 8) | |
204 | return zap_last_2bytes(fold) != 0; | |
205 | ||
206 | fold |= zap_last_2bytes((*(unsigned long *)(addr1 + 4)) ^ | |
207 | (*(unsigned long *)(addr2 + 4))); | |
208 | return fold != 0; | |
209 | #else | |
210 | return compare_ether_addr(addr1, addr2); | |
211 | #endif | |
212 | } | |
f001fde5 JP |
213 | |
214 | /** | |
215 | * is_etherdev_addr - Tell if given Ethernet address belongs to the device. | |
216 | * @dev: Pointer to a device structure | |
217 | * @addr: Pointer to a six-byte array containing the Ethernet address | |
218 | * | |
219 | * Compare passed address with all addresses of the device. Return true if the | |
220 | * address if one of the device addresses. | |
221 | * | |
222 | * Note that this function calls compare_ether_addr_64bits() so take care of | |
223 | * the right padding. | |
224 | */ | |
225 | static inline bool is_etherdev_addr(const struct net_device *dev, | |
226 | const u8 addr[6 + 2]) | |
227 | { | |
228 | struct netdev_hw_addr *ha; | |
229 | int res = 1; | |
230 | ||
231 | rcu_read_lock(); | |
232 | for_each_dev_addr(dev, ha) { | |
233 | res = compare_ether_addr_64bits(addr, ha->addr); | |
234 | if (!res) | |
235 | break; | |
236 | } | |
237 | rcu_read_unlock(); | |
238 | return !res; | |
239 | } | |
79165121 | 240 | #endif /* __KERNEL__ */ |
1da177e4 | 241 | |
aa4b9f53 HX |
242 | /** |
243 | * compare_ether_header - Compare two Ethernet headers | |
244 | * @a: Pointer to Ethernet header | |
245 | * @b: Pointer to Ethernet header | |
246 | * | |
247 | * Compare two ethernet headers, returns 0 if equal. | |
248 | * This assumes that the network header (i.e., IP header) is 4-byte | |
249 | * aligned OR the platform can handle unaligned access. This is the | |
250 | * case for all packets coming into netif_receive_skb or similar | |
251 | * entry points. | |
252 | */ | |
253 | ||
40d0802b | 254 | static inline unsigned long compare_ether_header(const void *a, const void *b) |
aa4b9f53 | 255 | { |
40d0802b ED |
256 | #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64 |
257 | unsigned long fold; | |
258 | ||
259 | /* | |
260 | * We want to compare 14 bytes: | |
261 | * [a0 ... a13] ^ [b0 ... b13] | |
262 | * Use two long XOR, ORed together, with an overlap of two bytes. | |
263 | * [a0 a1 a2 a3 a4 a5 a6 a7 ] ^ [b0 b1 b2 b3 b4 b5 b6 b7 ] | | |
264 | * [a6 a7 a8 a9 a10 a11 a12 a13] ^ [b6 b7 b8 b9 b10 b11 b12 b13] | |
265 | * This means the [a6 a7] ^ [b6 b7] part is done two times. | |
266 | */ | |
267 | fold = *(unsigned long *)a ^ *(unsigned long *)b; | |
268 | fold |= *(unsigned long *)(a + 6) ^ *(unsigned long *)(b + 6); | |
269 | return fold; | |
270 | #else | |
aa4b9f53 HX |
271 | u32 *a32 = (u32 *)((u8 *)a + 2); |
272 | u32 *b32 = (u32 *)((u8 *)b + 2); | |
273 | ||
274 | return (*(u16 *)a ^ *(u16 *)b) | (a32[0] ^ b32[0]) | | |
275 | (a32[1] ^ b32[1]) | (a32[2] ^ b32[2]); | |
40d0802b | 276 | #endif |
aa4b9f53 HX |
277 | } |
278 | ||
1da177e4 | 279 | #endif /* _LINUX_ETHERDEVICE_H */ |