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>
33 int eth_platform_get_mac_address(struct device
*dev
, u8
*mac_addr
);
34 unsigned char *arch_get_platform_mac_address(void);
35 int nvmem_get_mac_address(struct device
*dev
, void *addrbuf
);
36 u32
eth_get_headlen(void *data
, unsigned int max_len
);
37 __be16
eth_type_trans(struct sk_buff
*skb
, struct net_device
*dev
);
38 extern const struct header_ops eth_header_ops
;
40 int eth_header(struct sk_buff
*skb
, struct net_device
*dev
, unsigned short type
,
41 const void *daddr
, const void *saddr
, unsigned len
);
42 int eth_header_parse(const struct sk_buff
*skb
, unsigned char *haddr
);
43 int eth_header_cache(const struct neighbour
*neigh
, struct hh_cache
*hh
,
45 void eth_header_cache_update(struct hh_cache
*hh
, const struct net_device
*dev
,
46 const unsigned char *haddr
);
47 __be16
eth_header_parse_protocol(const struct sk_buff
*skb
);
48 int eth_prepare_mac_addr_change(struct net_device
*dev
, void *p
);
49 void eth_commit_mac_addr_change(struct net_device
*dev
, void *p
);
50 int eth_mac_addr(struct net_device
*dev
, void *p
);
51 int eth_change_mtu(struct net_device
*dev
, int new_mtu
);
52 int eth_validate_addr(struct net_device
*dev
);
54 struct net_device
*alloc_etherdev_mqs(int sizeof_priv
, unsigned int txqs
,
56 #define alloc_etherdev(sizeof_priv) alloc_etherdev_mq(sizeof_priv, 1)
57 #define alloc_etherdev_mq(sizeof_priv, count) alloc_etherdev_mqs(sizeof_priv, count, count)
59 struct net_device
*devm_alloc_etherdev_mqs(struct device
*dev
, int sizeof_priv
,
62 #define devm_alloc_etherdev(dev, sizeof_priv) devm_alloc_etherdev_mqs(dev, sizeof_priv, 1, 1)
64 struct sk_buff
*eth_gro_receive(struct list_head
*head
, struct sk_buff
*skb
);
65 int eth_gro_complete(struct sk_buff
*skb
, int nhoff
);
67 /* Reserved Ethernet Addresses per IEEE 802.1Q */
68 static const u8 eth_reserved_addr_base
[ETH_ALEN
] __aligned(2) =
69 { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x00 };
70 #define eth_stp_addr eth_reserved_addr_base
73 * is_link_local_ether_addr - Determine if given Ethernet address is link-local
74 * @addr: Pointer to a six-byte array containing the Ethernet address
76 * Return true if address is link local reserved addr (01:80:c2:00:00:0X) per
77 * IEEE 802.1Q 8.6.3 Frame filtering.
79 * Please note: addr must be aligned to u16.
81 static inline bool is_link_local_ether_addr(const u8
*addr
)
83 __be16
*a
= (__be16
*)addr
;
84 static const __be16
*b
= (const __be16
*)eth_reserved_addr_base
;
85 static const __be16 m
= cpu_to_be16(0xfff0);
87 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
88 return (((*(const u32
*)addr
) ^ (*(const u32
*)b
)) |
89 (__force
int)((a
[2] ^ b
[2]) & m
)) == 0;
91 return ((a
[0] ^ b
[0]) | (a
[1] ^ b
[1]) | ((a
[2] ^ b
[2]) & m
)) == 0;
96 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
97 * @addr: Pointer to a six-byte array containing the Ethernet address
99 * Return true if the address is all zeroes.
101 * Please note: addr must be aligned to u16.
103 static inline bool is_zero_ether_addr(const u8
*addr
)
105 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
106 return ((*(const u32
*)addr
) | (*(const u16
*)(addr
+ 4))) == 0;
108 return (*(const u16
*)(addr
+ 0) |
109 *(const u16
*)(addr
+ 2) |
110 *(const u16
*)(addr
+ 4)) == 0;
115 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
116 * @addr: Pointer to a six-byte array containing the Ethernet address
118 * Return true if the address is a multicast address.
119 * By definition the broadcast address is also a multicast address.
121 static inline bool is_multicast_ether_addr(const u8
*addr
)
123 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
124 u32 a
= *(const u32
*)addr
;
126 u16 a
= *(const u16
*)addr
;
129 return 0x01 & (a
>> ((sizeof(a
) * 8) - 8));
135 static inline bool is_multicast_ether_addr_64bits(const u8 addr
[6+2])
137 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
139 return 0x01 & ((*(const u64
*)addr
) >> 56);
141 return 0x01 & (*(const u64
*)addr
);
144 return is_multicast_ether_addr(addr
);
149 * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802).
150 * @addr: Pointer to a six-byte array containing the Ethernet address
152 * Return true if the address is a local address.
154 static inline bool is_local_ether_addr(const u8
*addr
)
156 return 0x02 & addr
[0];
160 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
161 * @addr: Pointer to a six-byte array containing the Ethernet address
163 * Return true if the address is the broadcast address.
165 * Please note: addr must be aligned to u16.
167 static inline bool is_broadcast_ether_addr(const u8
*addr
)
169 return (*(const u16
*)(addr
+ 0) &
170 *(const u16
*)(addr
+ 2) &
171 *(const u16
*)(addr
+ 4)) == 0xffff;
175 * is_unicast_ether_addr - Determine if the Ethernet address is unicast
176 * @addr: Pointer to a six-byte array containing the Ethernet address
178 * Return true if the address is a unicast address.
180 static inline bool is_unicast_ether_addr(const u8
*addr
)
182 return !is_multicast_ether_addr(addr
);
186 * is_valid_ether_addr - Determine if the given Ethernet address is valid
187 * @addr: Pointer to a six-byte array containing the Ethernet address
189 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
190 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
192 * Return true if the address is valid.
194 * Please note: addr must be aligned to u16.
196 static inline bool is_valid_ether_addr(const u8
*addr
)
198 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
199 * explicitly check for it here. */
200 return !is_multicast_ether_addr(addr
) && !is_zero_ether_addr(addr
);
204 * eth_proto_is_802_3 - Determine if a given Ethertype/length is a protocol
205 * @proto: Ethertype/length value to be tested
207 * Check that the value from the Ethertype/length field is a valid Ethertype.
209 * Return true if the valid is an 802.3 supported Ethertype.
211 static inline bool eth_proto_is_802_3(__be16 proto
)
214 /* if CPU is little endian mask off bits representing LSB */
215 proto
&= htons(0xFF00);
217 /* cast both to u16 and compare since LSB can be ignored */
218 return (__force u16
)proto
>= (__force u16
)htons(ETH_P_802_3_MIN
);
222 * eth_random_addr - Generate software assigned random Ethernet address
223 * @addr: Pointer to a six-byte array containing the Ethernet address
225 * Generate a random Ethernet address (MAC) that is not multicast
226 * and has the local assigned bit set.
228 static inline void eth_random_addr(u8
*addr
)
230 get_random_bytes(addr
, ETH_ALEN
);
231 addr
[0] &= 0xfe; /* clear multicast bit */
232 addr
[0] |= 0x02; /* set local assignment bit (IEEE802) */
235 #define random_ether_addr(addr) eth_random_addr(addr)
238 * eth_broadcast_addr - Assign broadcast address
239 * @addr: Pointer to a six-byte array containing the Ethernet address
241 * Assign the broadcast address to the given address array.
243 static inline void eth_broadcast_addr(u8
*addr
)
245 memset(addr
, 0xff, ETH_ALEN
);
249 * eth_zero_addr - Assign zero address
250 * @addr: Pointer to a six-byte array containing the Ethernet address
252 * Assign the zero address to the given address array.
254 static inline void eth_zero_addr(u8
*addr
)
256 memset(addr
, 0x00, ETH_ALEN
);
260 * eth_hw_addr_random - Generate software assigned random Ethernet and
262 * @dev: pointer to net_device structure
264 * Generate a random Ethernet address (MAC) to be used by a net device
265 * and set addr_assign_type so the state can be read by sysfs and be
268 static inline void eth_hw_addr_random(struct net_device
*dev
)
270 dev
->addr_assign_type
= NET_ADDR_RANDOM
;
271 eth_random_addr(dev
->dev_addr
);
275 * ether_addr_copy - Copy an Ethernet address
276 * @dst: Pointer to a six-byte array Ethernet address destination
277 * @src: Pointer to a six-byte array Ethernet address source
279 * Please note: dst & src must both be aligned to u16.
281 static inline void ether_addr_copy(u8
*dst
, const u8
*src
)
283 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
284 *(u32
*)dst
= *(const u32
*)src
;
285 *(u16
*)(dst
+ 4) = *(const u16
*)(src
+ 4);
288 const u16
*b
= (const u16
*)src
;
297 * eth_hw_addr_inherit - Copy dev_addr from another net_device
298 * @dst: pointer to net_device to copy dev_addr to
299 * @src: pointer to net_device to copy dev_addr from
301 * Copy the Ethernet address from one net_device to another along with
302 * the address attributes (addr_assign_type).
304 static inline void eth_hw_addr_inherit(struct net_device
*dst
,
305 struct net_device
*src
)
307 dst
->addr_assign_type
= src
->addr_assign_type
;
308 ether_addr_copy(dst
->dev_addr
, src
->dev_addr
);
312 * ether_addr_equal - Compare two Ethernet addresses
313 * @addr1: Pointer to a six-byte array containing the Ethernet address
314 * @addr2: Pointer other six-byte array containing the Ethernet address
316 * Compare two Ethernet addresses, returns true if equal
318 * Please note: addr1 & addr2 must both be aligned to u16.
320 static inline bool ether_addr_equal(const u8
*addr1
, const u8
*addr2
)
322 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
323 u32 fold
= ((*(const u32
*)addr1
) ^ (*(const u32
*)addr2
)) |
324 ((*(const u16
*)(addr1
+ 4)) ^ (*(const u16
*)(addr2
+ 4)));
328 const u16
*a
= (const u16
*)addr1
;
329 const u16
*b
= (const u16
*)addr2
;
331 return ((a
[0] ^ b
[0]) | (a
[1] ^ b
[1]) | (a
[2] ^ b
[2])) == 0;
336 * ether_addr_equal_64bits - Compare two Ethernet addresses
337 * @addr1: Pointer to an array of 8 bytes
338 * @addr2: Pointer to an other array of 8 bytes
340 * Compare two Ethernet addresses, returns true if equal, false otherwise.
342 * The function doesn't need any conditional branches and possibly uses
343 * word memory accesses on CPU allowing cheap unaligned memory reads.
344 * arrays = { byte1, byte2, byte3, byte4, byte5, byte6, pad1, pad2 }
346 * Please note that alignment of addr1 & addr2 are only guaranteed to be 16 bits.
349 static inline bool ether_addr_equal_64bits(const u8 addr1
[6+2],
352 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
353 u64 fold
= (*(const u64
*)addr1
) ^ (*(const u64
*)addr2
);
356 return (fold
>> 16) == 0;
358 return (fold
<< 16) == 0;
361 return ether_addr_equal(addr1
, addr2
);
366 * ether_addr_equal_unaligned - Compare two not u16 aligned Ethernet addresses
367 * @addr1: Pointer to a six-byte array containing the Ethernet address
368 * @addr2: Pointer other six-byte array containing the Ethernet address
370 * Compare two Ethernet addresses, returns true if equal
372 * Please note: Use only when any Ethernet address may not be u16 aligned.
374 static inline bool ether_addr_equal_unaligned(const u8
*addr1
, const u8
*addr2
)
376 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
377 return ether_addr_equal(addr1
, addr2
);
379 return memcmp(addr1
, addr2
, ETH_ALEN
) == 0;
384 * ether_addr_equal_masked - Compare two Ethernet addresses with a mask
385 * @addr1: Pointer to a six-byte array containing the 1st Ethernet address
386 * @addr2: Pointer to a six-byte array containing the 2nd Ethernet address
387 * @mask: Pointer to a six-byte array containing the Ethernet address bitmask
389 * Compare two Ethernet addresses with a mask, returns true if for every bit
390 * set in the bitmask the equivalent bits in the ethernet addresses are equal.
391 * Using a mask with all bits set is a slower ether_addr_equal.
393 static inline bool ether_addr_equal_masked(const u8
*addr1
, const u8
*addr2
,
398 for (i
= 0; i
< ETH_ALEN
; i
++) {
399 if ((addr1
[i
] ^ addr2
[i
]) & mask
[i
])
407 * ether_addr_to_u64 - Convert an Ethernet address into a u64 value.
408 * @addr: Pointer to a six-byte array containing the Ethernet address
410 * Return a u64 value of the address
412 static inline u64
ether_addr_to_u64(const u8
*addr
)
417 for (i
= 0; i
< ETH_ALEN
; i
++)
418 u
= u
<< 8 | addr
[i
];
424 * u64_to_ether_addr - Convert a u64 to an Ethernet address.
425 * @u: u64 to convert to an Ethernet MAC address
426 * @addr: Pointer to a six-byte array to contain the Ethernet address
428 static inline void u64_to_ether_addr(u64 u
, u8
*addr
)
432 for (i
= ETH_ALEN
- 1; i
>= 0; i
--) {
439 * eth_addr_dec - Decrement the given MAC address
441 * @addr: Pointer to a six-byte array containing Ethernet address to decrement
443 static inline void eth_addr_dec(u8
*addr
)
445 u64 u
= ether_addr_to_u64(addr
);
448 u64_to_ether_addr(u
, addr
);
452 * eth_addr_inc() - Increment the given MAC address.
453 * @addr: Pointer to a six-byte array containing Ethernet address to increment.
455 static inline void eth_addr_inc(u8
*addr
)
457 u64 u
= ether_addr_to_u64(addr
);
460 u64_to_ether_addr(u
, addr
);
464 * is_etherdev_addr - Tell if given Ethernet address belongs to the device.
465 * @dev: Pointer to a device structure
466 * @addr: Pointer to a six-byte array containing the Ethernet address
468 * Compare passed address with all addresses of the device. Return true if the
469 * address if one of the device addresses.
471 * Note that this function calls ether_addr_equal_64bits() so take care of
474 static inline bool is_etherdev_addr(const struct net_device
*dev
,
475 const u8 addr
[6 + 2])
477 struct netdev_hw_addr
*ha
;
481 for_each_dev_addr(dev
, ha
) {
482 res
= ether_addr_equal_64bits(addr
, ha
->addr
);
489 #endif /* __KERNEL__ */
492 * compare_ether_header - Compare two Ethernet headers
493 * @a: Pointer to Ethernet header
494 * @b: Pointer to Ethernet header
496 * Compare two Ethernet headers, returns 0 if equal.
497 * This assumes that the network header (i.e., IP header) is 4-byte
498 * aligned OR the platform can handle unaligned access. This is the
499 * case for all packets coming into netif_receive_skb or similar
503 static inline unsigned long compare_ether_header(const void *a
, const void *b
)
505 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
509 * We want to compare 14 bytes:
510 * [a0 ... a13] ^ [b0 ... b13]
511 * Use two long XOR, ORed together, with an overlap of two bytes.
512 * [a0 a1 a2 a3 a4 a5 a6 a7 ] ^ [b0 b1 b2 b3 b4 b5 b6 b7 ] |
513 * [a6 a7 a8 a9 a10 a11 a12 a13] ^ [b6 b7 b8 b9 b10 b11 b12 b13]
514 * This means the [a6 a7] ^ [b6 b7] part is done two times.
516 fold
= *(unsigned long *)a
^ *(unsigned long *)b
;
517 fold
|= *(unsigned long *)(a
+ 6) ^ *(unsigned long *)(b
+ 6);
520 u32
*a32
= (u32
*)((u8
*)a
+ 2);
521 u32
*b32
= (u32
*)((u8
*)b
+ 2);
523 return (*(u16
*)a
^ *(u16
*)b
) | (a32
[0] ^ b32
[0]) |
524 (a32
[1] ^ b32
[1]) | (a32
[2] ^ b32
[2]);
529 * eth_skb_pad - Pad buffer to mininum number of octets for Ethernet frame
530 * @skb: Buffer to pad
532 * An Ethernet frame should have a minimum size of 60 bytes. This function
533 * takes short frames and pads them with zeros up to the 60 byte limit.
535 static inline int eth_skb_pad(struct sk_buff
*skb
)
537 return skb_put_padto(skb
, ETH_ZLEN
);
540 #endif /* _LINUX_ETHERDEVICE_H */