Blame view
include/linux/etherdevice.h
13.6 KB
1da177e4c
|
1 2 3 4 5 6 7 8 9 |
/* * INET An implementation of the TCP/IP protocol suite for the LINUX * operating system. NET is implemented using the BSD Socket * interface as the means of communication with the user level. * * Definitions for the Ethernet handlers. * * Version: @(#)eth.h 1.0.4 05/13/93 * |
02c30a84e
|
10 |
* Authors: Ross Biro |
1da177e4c
|
11 12 13 14 15 16 17 18 19 20 |
* Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG> * * Relocated to include/linux where it belongs by Alan Cox * <gw4pts@gw4pts.ampr.org> * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version * 2 of the License, or (at your option) any later version. * |
1da177e4c
|
21 22 23 24 25 |
*/ #ifndef _LINUX_ETHERDEVICE_H #define _LINUX_ETHERDEVICE_H #include <linux/if_ether.h> |
bcd61272d
|
26 |
#include <linux/netdevice.h> |
1da177e4c
|
27 |
#include <linux/random.h> |
1f87e235e
|
28 |
#include <asm/unaligned.h> |
0d74c42f7
|
29 |
#include <asm/bitsperlong.h> |
1da177e4c
|
30 31 |
#ifdef __KERNEL__ |
56193d1bc
|
32 |
u32 eth_get_headlen(void *data, unsigned int max_len); |
f629d208d
|
33 |
__be16 eth_type_trans(struct sk_buff *skb, struct net_device *dev); |
3b04ddde0
|
34 |
extern const struct header_ops eth_header_ops; |
f629d208d
|
35 36 |
int eth_header(struct sk_buff *skb, struct net_device *dev, unsigned short type, const void *daddr, const void *saddr, unsigned len); |
f629d208d
|
37 38 39 40 41 42 43 44 45 46 |
int eth_header_parse(const struct sk_buff *skb, unsigned char *haddr); int eth_header_cache(const struct neighbour *neigh, struct hh_cache *hh, __be16 type); void eth_header_cache_update(struct hh_cache *hh, const struct net_device *dev, const unsigned char *haddr); int eth_prepare_mac_addr_change(struct net_device *dev, void *p); void eth_commit_mac_addr_change(struct net_device *dev, void *p); int eth_mac_addr(struct net_device *dev, void *p); int eth_change_mtu(struct net_device *dev, int new_mtu); int eth_validate_addr(struct net_device *dev); |
ccad637b0
|
47 |
|
f629d208d
|
48 |
struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs, |
36909ea43
|
49 |
unsigned int rxqs); |
f25f4e448
|
50 |
#define alloc_etherdev(sizeof_priv) alloc_etherdev_mq(sizeof_priv, 1) |
36909ea43
|
51 |
#define alloc_etherdev_mq(sizeof_priv, count) alloc_etherdev_mqs(sizeof_priv, count, count) |
1da177e4c
|
52 |
|
9b174d88c
|
53 54 55 |
struct sk_buff **eth_gro_receive(struct sk_buff **head, struct sk_buff *skb); int eth_gro_complete(struct sk_buff *skb, int nhoff); |
b3343a2a2
|
56 |
/* Reserved Ethernet Addresses per IEEE 802.1Q */ |
2bc80059f
|
57 58 |
static const u8 eth_reserved_addr_base[ETH_ALEN] __aligned(2) = { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x00 }; |
b3343a2a2
|
59 60 |
/** |
46acc460c
|
61 |
* is_link_local_ether_addr - Determine if given Ethernet address is link-local |
b3343a2a2
|
62 63 64 65 |
* @addr: Pointer to a six-byte array containing the Ethernet address * * Return true if address is link local reserved addr (01:80:c2:00:00:0X) per * IEEE 802.1Q 8.6.3 Frame filtering. |
2c722fe1c
|
66 67 |
* * Please note: addr must be aligned to u16. |
b3343a2a2
|
68 |
*/ |
46acc460c
|
69 |
static inline bool is_link_local_ether_addr(const u8 *addr) |
b3343a2a2
|
70 |
{ |
46acc460c
|
71 |
__be16 *a = (__be16 *)addr; |
2bc80059f
|
72 |
static const __be16 *b = (const __be16 *)eth_reserved_addr_base; |
b3343a2a2
|
73 |
static const __be16 m = cpu_to_be16(0xfff0); |
2c722fe1c
|
74 75 |
#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) return (((*(const u32 *)addr) ^ (*(const u32 *)b)) | |
fbaff3ef8
|
76 |
(__force int)((a[2] ^ b[2]) & m)) == 0; |
2c722fe1c
|
77 |
#else |
b3343a2a2
|
78 |
return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | ((a[2] ^ b[2]) & m)) == 0; |
2c722fe1c
|
79 |
#endif |
b3343a2a2
|
80 |
} |
1da177e4c
|
81 |
/** |
c2da8acaf
|
82 83 84 85 |
* is_zero_ether_addr - Determine if give Ethernet address is all zeros. * @addr: Pointer to a six-byte array containing the Ethernet address * * Return true if the address is all zeroes. |
2c722fe1c
|
86 87 |
* * Please note: addr must be aligned to u16. |
1da177e4c
|
88 |
*/ |
b44907e64
|
89 |
static inline bool is_zero_ether_addr(const u8 *addr) |
1da177e4c
|
90 |
{ |
2c722fe1c
|
91 92 93 94 95 96 97 |
#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) return ((*(const u32 *)addr) | (*(const u16 *)(addr + 4))) == 0; #else return (*(const u16 *)(addr + 0) | *(const u16 *)(addr + 2) | *(const u16 *)(addr + 4)) == 0; #endif |
1da177e4c
|
98 99 100 |
} /** |
c2da8acaf
|
101 |
* is_multicast_ether_addr - Determine if the Ethernet address is a multicast. |
79165121b
|
102 103 104 |
* @addr: Pointer to a six-byte array containing the Ethernet address * * Return true if the address is a multicast address. |
88df8ef59
|
105 |
* By definition the broadcast address is also a multicast address. |
79165121b
|
106 |
*/ |
b44907e64
|
107 |
static inline bool is_multicast_ether_addr(const u8 *addr) |
79165121b
|
108 |
{ |
d54385ce6
|
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) u32 a = *(const u32 *)addr; #else u16 a = *(const u16 *)addr; #endif #ifdef __BIG_ENDIAN return 0x01 & (a >> ((sizeof(a) * 8) - 8)); #else return 0x01 & a; #endif } static inline bool is_multicast_ether_addr_64bits(const u8 addr[6+2]) { #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64 #ifdef __BIG_ENDIAN return 0x01 & ((*(const u64 *)addr) >> 56); #else return 0x01 & (*(const u64 *)addr); #endif #else return is_multicast_ether_addr(addr); #endif |
79165121b
|
132 |
} |
c2da8acaf
|
133 |
/** |
bc2cda1eb
|
134 |
* is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802). |
e024715f5
|
135 136 137 138 |
* @addr: Pointer to a six-byte array containing the Ethernet address * * Return true if the address is a local address. */ |
b44907e64
|
139 |
static inline bool is_local_ether_addr(const u8 *addr) |
e024715f5
|
140 |
{ |
a02cec215
|
141 |
return 0x02 & addr[0]; |
e024715f5
|
142 143 144 |
} /** |
c2da8acaf
|
145 146 147 148 |
* is_broadcast_ether_addr - Determine if the Ethernet address is broadcast * @addr: Pointer to a six-byte array containing the Ethernet address * * Return true if the address is the broadcast address. |
2c722fe1c
|
149 150 |
* * Please note: addr must be aligned to u16. |
c2da8acaf
|
151 |
*/ |
b44907e64
|
152 |
static inline bool is_broadcast_ether_addr(const u8 *addr) |
9bd481f85
|
153 |
{ |
2c722fe1c
|
154 155 156 |
return (*(const u16 *)(addr + 0) & *(const u16 *)(addr + 2) & *(const u16 *)(addr + 4)) == 0xffff; |
9bd481f85
|
157 |
} |
79165121b
|
158 |
/** |
51e7eed79
|
159 160 161 162 163 |
* is_unicast_ether_addr - Determine if the Ethernet address is unicast * @addr: Pointer to a six-byte array containing the Ethernet address * * Return true if the address is a unicast address. */ |
b44907e64
|
164 |
static inline bool is_unicast_ether_addr(const u8 *addr) |
51e7eed79
|
165 166 167 168 169 |
{ return !is_multicast_ether_addr(addr); } /** |
1da177e4c
|
170 171 172 173 |
* is_valid_ether_addr - Determine if the given Ethernet address is valid * @addr: Pointer to a six-byte array containing the Ethernet address * * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not |
79165121b
|
174 |
* a multicast address, and is not FF:FF:FF:FF:FF:FF. |
1da177e4c
|
175 176 |
* * Return true if the address is valid. |
2c722fe1c
|
177 178 |
* * Please note: addr must be aligned to u16. |
1da177e4c
|
179 |
*/ |
b44907e64
|
180 |
static inline bool is_valid_ether_addr(const u8 *addr) |
1da177e4c
|
181 |
{ |
79165121b
|
182 183 184 |
/* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to * explicitly check for it here. */ return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr); |
1da177e4c
|
185 186 187 |
} /** |
2c7a88c25
|
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
* eth_proto_is_802_3 - Determine if a given Ethertype/length is a protocol * @proto: Ethertype/length value to be tested * * Check that the value from the Ethertype/length field is a valid Ethertype. * * Return true if the valid is an 802.3 supported Ethertype. */ static inline bool eth_proto_is_802_3(__be16 proto) { #ifndef __BIG_ENDIAN /* if CPU is little endian mask off bits representing LSB */ proto &= htons(0xFF00); #endif /* cast both to u16 and compare since LSB can be ignored */ return (__force u16)proto >= (__force u16)htons(ETH_P_802_3_MIN); } /** |
0a4dd5949
|
206 |
* eth_random_addr - Generate software assigned random Ethernet address |
1da177e4c
|
207 208 209 210 211 |
* @addr: Pointer to a six-byte array containing the Ethernet address * * Generate a random Ethernet address (MAC) that is not multicast * and has the local assigned bit set. */ |
0a4dd5949
|
212 |
static inline void eth_random_addr(u8 *addr) |
1da177e4c
|
213 |
{ |
0a4dd5949
|
214 215 216 |
get_random_bytes(addr, ETH_ALEN); addr[0] &= 0xfe; /* clear multicast bit */ addr[0] |= 0x02; /* set local assignment bit (IEEE802) */ |
1da177e4c
|
217 |
} |
360ac8e2f
|
218 |
|
0a4dd5949
|
219 |
#define random_ether_addr(addr) eth_random_addr(addr) |
360ac8e2f
|
220 |
/** |
ad7eee98b
|
221 222 223 224 225 226 227 228 229 230 231 |
* eth_broadcast_addr - Assign broadcast address * @addr: Pointer to a six-byte array containing the Ethernet address * * Assign the broadcast address to the given address array. */ static inline void eth_broadcast_addr(u8 *addr) { memset(addr, 0xff, ETH_ALEN); } /** |
6d57e9078
|
232 233 234 235 236 237 238 239 240 241 242 |
* eth_zero_addr - Assign zero address * @addr: Pointer to a six-byte array containing the Ethernet address * * Assign the zero address to the given address array. */ static inline void eth_zero_addr(u8 *addr) { memset(addr, 0x00, ETH_ALEN); } /** |
1a0d6ae57
|
243 244 |
* eth_hw_addr_random - Generate software assigned random Ethernet and * set device flag |
c1f79426e
|
245 |
* @dev: pointer to net_device structure |
c1f79426e
|
246 |
* |
1a0d6ae57
|
247 248 249 |
* Generate a random Ethernet address (MAC) to be used by a net device * and set addr_assign_type so the state can be read by sysfs and be * used by userspace. |
c1f79426e
|
250 |
*/ |
1a0d6ae57
|
251 |
static inline void eth_hw_addr_random(struct net_device *dev) |
c1f79426e
|
252 |
{ |
e41b2d7fe
|
253 |
dev->addr_assign_type = NET_ADDR_RANDOM; |
0a4dd5949
|
254 |
eth_random_addr(dev->dev_addr); |
c1f79426e
|
255 256 257 |
} /** |
286ab723d
|
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 |
* ether_addr_copy - Copy an Ethernet address * @dst: Pointer to a six-byte array Ethernet address destination * @src: Pointer to a six-byte array Ethernet address source * * Please note: dst & src must both be aligned to u16. */ static inline void ether_addr_copy(u8 *dst, const u8 *src) { #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) *(u32 *)dst = *(const u32 *)src; *(u16 *)(dst + 4) = *(const u16 *)(src + 4); #else u16 *a = (u16 *)dst; const u16 *b = (const u16 *)src; a[0] = b[0]; a[1] = b[1]; a[2] = b[2]; #endif } /** |
83a093b48
|
280 281 282 283 284 285 286 287 288 289 290 |
* eth_hw_addr_inherit - Copy dev_addr from another net_device * @dst: pointer to net_device to copy dev_addr to * @src: pointer to net_device to copy dev_addr from * * Copy the Ethernet address from one net_device to another along with * the address attributes (addr_assign_type). */ static inline void eth_hw_addr_inherit(struct net_device *dst, struct net_device *src) { dst->addr_assign_type = src->addr_assign_type; |
286ab723d
|
291 |
ether_addr_copy(dst->dev_addr, src->dev_addr); |
83a093b48
|
292 293 294 |
} /** |
a599b0f54
|
295 296 297 298 |
* ether_addr_equal - Compare two Ethernet addresses * @addr1: Pointer to a six-byte array containing the Ethernet address * @addr2: Pointer other six-byte array containing the Ethernet address * |
048b899ce
|
299 |
* Compare two Ethernet addresses, returns true if equal |
0d74c42f7
|
300 301 |
* * Please note: addr1 & addr2 must both be aligned to u16. |
a599b0f54
|
302 303 304 |
*/ static inline bool ether_addr_equal(const u8 *addr1, const u8 *addr2) { |
0d74c42f7
|
305 306 307 |
#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) u32 fold = ((*(const u32 *)addr1) ^ (*(const u32 *)addr2)) | ((*(const u16 *)(addr1 + 4)) ^ (*(const u16 *)(addr2 + 4))); |
a599b0f54
|
308 |
|
0d74c42f7
|
309 |
return fold == 0; |
1f87e235e
|
310 |
#else |
0d74c42f7
|
311 312 313 314 |
const u16 *a = (const u16 *)addr1; const u16 *b = (const u16 *)addr2; return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) == 0; |
1f87e235e
|
315 316 317 318 |
#endif } /** |
e550ba1af
|
319 |
* ether_addr_equal_64bits - Compare two Ethernet addresses |
1f87e235e
|
320 321 322 |
* @addr1: Pointer to an array of 8 bytes * @addr2: Pointer to an other array of 8 bytes * |
048b899ce
|
323 |
* Compare two Ethernet addresses, returns true if equal, false otherwise. |
e550ba1af
|
324 |
* |
1c430a727
|
325 326 |
* The function doesn't need any conditional branches and possibly uses * word memory accesses on CPU allowing cheap unaligned memory reads. |
048b899ce
|
327 |
* arrays = { byte1, byte2, byte3, byte4, byte5, byte6, pad1, pad2 } |
1f87e235e
|
328 |
* |
048b899ce
|
329 |
* Please note that alignment of addr1 & addr2 are only guaranteed to be 16 bits. |
1f87e235e
|
330 |
*/ |
e550ba1af
|
331 332 |
static inline bool ether_addr_equal_64bits(const u8 addr1[6+2], const u8 addr2[6+2]) |
1f87e235e
|
333 |
{ |
0d74c42f7
|
334 335 |
#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64 u64 fold = (*(const u64 *)addr1) ^ (*(const u64 *)addr2); |
1f87e235e
|
336 |
|
0d74c42f7
|
337 338 339 340 341 |
#ifdef __BIG_ENDIAN return (fold >> 16) == 0; #else return (fold << 16) == 0; #endif |
1f87e235e
|
342 |
#else |
e550ba1af
|
343 |
return ether_addr_equal(addr1, addr2); |
1f87e235e
|
344 345 |
#endif } |
f001fde5e
|
346 347 |
/** |
73eaef87e
|
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 |
* ether_addr_equal_unaligned - Compare two not u16 aligned Ethernet addresses * @addr1: Pointer to a six-byte array containing the Ethernet address * @addr2: Pointer other six-byte array containing the Ethernet address * * Compare two Ethernet addresses, returns true if equal * * Please note: Use only when any Ethernet address may not be u16 aligned. */ static inline bool ether_addr_equal_unaligned(const u8 *addr1, const u8 *addr2) { #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) return ether_addr_equal(addr1, addr2); #else return memcmp(addr1, addr2, ETH_ALEN) == 0; #endif } /** |
f001fde5e
|
366 367 368 369 370 371 372 |
* is_etherdev_addr - Tell if given Ethernet address belongs to the device. * @dev: Pointer to a device structure * @addr: Pointer to a six-byte array containing the Ethernet address * * Compare passed address with all addresses of the device. Return true if the * address if one of the device addresses. * |
e550ba1af
|
373 |
* Note that this function calls ether_addr_equal_64bits() so take care of |
f001fde5e
|
374 375 376 377 378 379 |
* the right padding. */ static inline bool is_etherdev_addr(const struct net_device *dev, const u8 addr[6 + 2]) { struct netdev_hw_addr *ha; |
e550ba1af
|
380 |
bool res = false; |
f001fde5e
|
381 382 383 |
rcu_read_lock(); for_each_dev_addr(dev, ha) { |
e550ba1af
|
384 385 |
res = ether_addr_equal_64bits(addr, ha->addr); if (res) |
f001fde5e
|
386 387 388 |
break; } rcu_read_unlock(); |
e550ba1af
|
389 |
return res; |
f001fde5e
|
390 |
} |
79165121b
|
391 |
#endif /* __KERNEL__ */ |
1da177e4c
|
392 |
|
aa4b9f533
|
393 394 395 396 397 |
/** * compare_ether_header - Compare two Ethernet headers * @a: Pointer to Ethernet header * @b: Pointer to Ethernet header * |
048b899ce
|
398 |
* Compare two Ethernet headers, returns 0 if equal. |
aa4b9f533
|
399 400 401 402 403 |
* This assumes that the network header (i.e., IP header) is 4-byte * aligned OR the platform can handle unaligned access. This is the * case for all packets coming into netif_receive_skb or similar * entry points. */ |
40d0802b3
|
404 |
static inline unsigned long compare_ether_header(const void *a, const void *b) |
aa4b9f533
|
405 |
{ |
40d0802b3
|
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64 unsigned long fold; /* * We want to compare 14 bytes: * [a0 ... a13] ^ [b0 ... b13] * Use two long XOR, ORed together, with an overlap of two bytes. * [a0 a1 a2 a3 a4 a5 a6 a7 ] ^ [b0 b1 b2 b3 b4 b5 b6 b7 ] | * [a6 a7 a8 a9 a10 a11 a12 a13] ^ [b6 b7 b8 b9 b10 b11 b12 b13] * This means the [a6 a7] ^ [b6 b7] part is done two times. */ fold = *(unsigned long *)a ^ *(unsigned long *)b; fold |= *(unsigned long *)(a + 6) ^ *(unsigned long *)(b + 6); return fold; #else |
aa4b9f533
|
421 422 423 424 425 |
u32 *a32 = (u32 *)((u8 *)a + 2); u32 *b32 = (u32 *)((u8 *)b + 2); return (*(u16 *)a ^ *(u16 *)b) | (a32[0] ^ b32[0]) | (a32[1] ^ b32[1]) | (a32[2] ^ b32[2]); |
40d0802b3
|
426 |
#endif |
aa4b9f533
|
427 |
} |
9c0c11242
|
428 429 430 431 432 433 434 435 436 437 438 |
/** * eth_skb_pad - Pad buffer to mininum number of octets for Ethernet frame * @skb: Buffer to pad * * An Ethernet frame should have a minimum size of 60 bytes. This function * takes short frames and pads them with zeros up to the 60 byte limit. */ static inline int eth_skb_pad(struct sk_buff *skb) { return skb_put_padto(skb, ETH_ZLEN); } |
1da177e4c
|
439 |
#endif /* _LINUX_ETHERDEVICE_H */ |