1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * INET An implementation of the TCP/IP protocol suite for the LINUX
4 * operating system. NET is implemented using the BSD Socket
5 * interface as the means of communication with the user level.
7 * Definitions for the Ethernet handlers.
9 * Version: @(#)eth.h 1.0.4 05/13/93
12 * Fred N. van Kempen, <waltje@uWalt.NL.Mugnet.ORG>
14 * Relocated to include/linux where it belongs by Alan Cox
15 * <gw4pts@gw4pts.ampr.org>
17 #ifndef _LINUX_ETHERDEVICE_H
18 #define _LINUX_ETHERDEVICE_H
20 #include <linux/if_ether.h>
21 #include <linux/netdevice.h>
22 #include <linux/random.h>
23 #include <linux/crc32.h>
24 #include <asm/unaligned.h>
25 #include <asm/bitsperlong.h>
29 int eth_platform_get_mac_address(struct device
*dev
, u8
*mac_addr
);
30 unsigned char *arch_get_platform_mac_address(void);
31 int nvmem_get_mac_address(struct device
*dev
, void *addrbuf
);
32 u32
eth_get_headlen(const struct net_device
*dev
, void *data
, unsigned int len
);
33 __be16
eth_type_trans(struct sk_buff
*skb
, struct net_device
*dev
);
34 extern const struct header_ops eth_header_ops
;
36 int eth_header(struct sk_buff
*skb
, struct net_device
*dev
, unsigned short type
,
37 const void *daddr
, const void *saddr
, unsigned len
);
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 __be16
eth_header_parse_protocol(const struct sk_buff
*skb
);
44 int eth_prepare_mac_addr_change(struct net_device
*dev
, void *p
);
45 void eth_commit_mac_addr_change(struct net_device
*dev
, void *p
);
46 int eth_mac_addr(struct net_device
*dev
, void *p
);
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 struct net_device
*devm_alloc_etherdev_mqs(struct device
*dev
, int sizeof_priv
,
57 #define devm_alloc_etherdev(dev, sizeof_priv) devm_alloc_etherdev_mqs(dev, sizeof_priv, 1, 1)
59 struct sk_buff
*eth_gro_receive(struct list_head
*head
, struct sk_buff
*skb
);
60 int eth_gro_complete(struct sk_buff
*skb
, int nhoff
);
62 /* Reserved Ethernet Addresses per IEEE 802.1Q */
63 static const u8 eth_reserved_addr_base
[ETH_ALEN
] __aligned(2) =
64 { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x00 };
65 #define eth_stp_addr eth_reserved_addr_base
68 * is_link_local_ether_addr - Determine if given Ethernet address is link-local
69 * @addr: Pointer to a six-byte array containing the Ethernet address
71 * Return true if address is link local reserved addr (01:80:c2:00:00:0X) per
72 * IEEE 802.1Q 8.6.3 Frame filtering.
74 * Please note: addr must be aligned to u16.
76 static inline bool is_link_local_ether_addr(const u8
*addr
)
78 __be16
*a
= (__be16
*)addr
;
79 static const __be16
*b
= (const __be16
*)eth_reserved_addr_base
;
80 static const __be16 m
= cpu_to_be16(0xfff0);
82 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
83 return (((*(const u32
*)addr
) ^ (*(const u32
*)b
)) |
84 (__force
int)((a
[2] ^ b
[2]) & m
)) == 0;
86 return ((a
[0] ^ b
[0]) | (a
[1] ^ b
[1]) | ((a
[2] ^ b
[2]) & m
)) == 0;
91 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
92 * @addr: Pointer to a six-byte array containing the Ethernet address
94 * Return true if the address is all zeroes.
96 * Please note: addr must be aligned to u16.
98 static inline bool is_zero_ether_addr(const u8
*addr
)
100 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
101 return ((*(const u32
*)addr
) | (*(const u16
*)(addr
+ 4))) == 0;
103 return (*(const u16
*)(addr
+ 0) |
104 *(const u16
*)(addr
+ 2) |
105 *(const u16
*)(addr
+ 4)) == 0;
110 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
111 * @addr: Pointer to a six-byte array containing the Ethernet address
113 * Return true if the address is a multicast address.
114 * By definition the broadcast address is also a multicast address.
116 static inline bool is_multicast_ether_addr(const u8
*addr
)
118 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
119 u32 a
= *(const u32
*)addr
;
121 u16 a
= *(const u16
*)addr
;
124 return 0x01 & (a
>> ((sizeof(a
) * 8) - 8));
130 static inline bool is_multicast_ether_addr_64bits(const u8 addr
[6+2])
132 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
134 return 0x01 & ((*(const u64
*)addr
) >> 56);
136 return 0x01 & (*(const u64
*)addr
);
139 return is_multicast_ether_addr(addr
);
144 * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802).
145 * @addr: Pointer to a six-byte array containing the Ethernet address
147 * Return true if the address is a local address.
149 static inline bool is_local_ether_addr(const u8
*addr
)
151 return 0x02 & addr
[0];
155 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
156 * @addr: Pointer to a six-byte array containing the Ethernet address
158 * Return true if the address is the broadcast address.
160 * Please note: addr must be aligned to u16.
162 static inline bool is_broadcast_ether_addr(const u8
*addr
)
164 return (*(const u16
*)(addr
+ 0) &
165 *(const u16
*)(addr
+ 2) &
166 *(const u16
*)(addr
+ 4)) == 0xffff;
170 * is_unicast_ether_addr - Determine if the Ethernet address is unicast
171 * @addr: Pointer to a six-byte array containing the Ethernet address
173 * Return true if the address is a unicast address.
175 static inline bool is_unicast_ether_addr(const u8
*addr
)
177 return !is_multicast_ether_addr(addr
);
181 * is_valid_ether_addr - Determine if the given Ethernet address is valid
182 * @addr: Pointer to a six-byte array containing the Ethernet address
184 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
185 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
187 * Return true if the address is valid.
189 * Please note: addr must be aligned to u16.
191 static inline bool is_valid_ether_addr(const u8
*addr
)
193 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
194 * explicitly check for it here. */
195 return !is_multicast_ether_addr(addr
) && !is_zero_ether_addr(addr
);
199 * eth_proto_is_802_3 - Determine if a given Ethertype/length is a protocol
200 * @proto: Ethertype/length value to be tested
202 * Check that the value from the Ethertype/length field is a valid Ethertype.
204 * Return true if the valid is an 802.3 supported Ethertype.
206 static inline bool eth_proto_is_802_3(__be16 proto
)
209 /* if CPU is little endian mask off bits representing LSB */
210 proto
&= htons(0xFF00);
212 /* cast both to u16 and compare since LSB can be ignored */
213 return (__force u16
)proto
>= (__force u16
)htons(ETH_P_802_3_MIN
);
217 * eth_random_addr - Generate software assigned random Ethernet address
218 * @addr: Pointer to a six-byte array containing the Ethernet address
220 * Generate a random Ethernet address (MAC) that is not multicast
221 * and has the local assigned bit set.
223 static inline void eth_random_addr(u8
*addr
)
225 get_random_bytes(addr
, ETH_ALEN
);
226 addr
[0] &= 0xfe; /* clear multicast bit */
227 addr
[0] |= 0x02; /* set local assignment bit (IEEE802) */
230 #define random_ether_addr(addr) eth_random_addr(addr)
233 * eth_broadcast_addr - Assign broadcast address
234 * @addr: Pointer to a six-byte array containing the Ethernet address
236 * Assign the broadcast address to the given address array.
238 static inline void eth_broadcast_addr(u8
*addr
)
240 memset(addr
, 0xff, ETH_ALEN
);
244 * eth_zero_addr - Assign zero address
245 * @addr: Pointer to a six-byte array containing the Ethernet address
247 * Assign the zero address to the given address array.
249 static inline void eth_zero_addr(u8
*addr
)
251 memset(addr
, 0x00, ETH_ALEN
);
255 * eth_hw_addr_random - Generate software assigned random Ethernet and
257 * @dev: pointer to net_device structure
259 * Generate a random Ethernet address (MAC) to be used by a net device
260 * and set addr_assign_type so the state can be read by sysfs and be
263 static inline void eth_hw_addr_random(struct net_device
*dev
)
265 dev
->addr_assign_type
= NET_ADDR_RANDOM
;
266 eth_random_addr(dev
->dev_addr
);
270 * eth_hw_addr_crc - Calculate CRC from netdev_hw_addr
271 * @ha: pointer to hardware address
273 * Calculate CRC from a hardware address as basis for filter hashes.
275 static inline u32
eth_hw_addr_crc(struct netdev_hw_addr
*ha
)
277 return ether_crc(ETH_ALEN
, ha
->addr
);
281 * ether_addr_copy - Copy an Ethernet address
282 * @dst: Pointer to a six-byte array Ethernet address destination
283 * @src: Pointer to a six-byte array Ethernet address source
285 * Please note: dst & src must both be aligned to u16.
287 static inline void ether_addr_copy(u8
*dst
, const u8
*src
)
289 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
290 *(u32
*)dst
= *(const u32
*)src
;
291 *(u16
*)(dst
+ 4) = *(const u16
*)(src
+ 4);
294 const u16
*b
= (const u16
*)src
;
303 * eth_hw_addr_inherit - Copy dev_addr from another net_device
304 * @dst: pointer to net_device to copy dev_addr to
305 * @src: pointer to net_device to copy dev_addr from
307 * Copy the Ethernet address from one net_device to another along with
308 * the address attributes (addr_assign_type).
310 static inline void eth_hw_addr_inherit(struct net_device
*dst
,
311 struct net_device
*src
)
313 dst
->addr_assign_type
= src
->addr_assign_type
;
314 ether_addr_copy(dst
->dev_addr
, src
->dev_addr
);
318 * ether_addr_equal - Compare two Ethernet addresses
319 * @addr1: Pointer to a six-byte array containing the Ethernet address
320 * @addr2: Pointer other six-byte array containing the Ethernet address
322 * Compare two Ethernet addresses, returns true if equal
324 * Please note: addr1 & addr2 must both be aligned to u16.
326 static inline bool ether_addr_equal(const u8
*addr1
, const u8
*addr2
)
328 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
329 u32 fold
= ((*(const u32
*)addr1
) ^ (*(const u32
*)addr2
)) |
330 ((*(const u16
*)(addr1
+ 4)) ^ (*(const u16
*)(addr2
+ 4)));
334 const u16
*a
= (const u16
*)addr1
;
335 const u16
*b
= (const u16
*)addr2
;
337 return ((a
[0] ^ b
[0]) | (a
[1] ^ b
[1]) | (a
[2] ^ b
[2])) == 0;
342 * ether_addr_equal_64bits - Compare two Ethernet addresses
343 * @addr1: Pointer to an array of 8 bytes
344 * @addr2: Pointer to an other array of 8 bytes
346 * Compare two Ethernet addresses, returns true if equal, false otherwise.
348 * The function doesn't need any conditional branches and possibly uses
349 * word memory accesses on CPU allowing cheap unaligned memory reads.
350 * arrays = { byte1, byte2, byte3, byte4, byte5, byte6, pad1, pad2 }
352 * Please note that alignment of addr1 & addr2 are only guaranteed to be 16 bits.
355 static inline bool ether_addr_equal_64bits(const u8 addr1
[6+2],
358 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
359 u64 fold
= (*(const u64
*)addr1
) ^ (*(const u64
*)addr2
);
362 return (fold
>> 16) == 0;
364 return (fold
<< 16) == 0;
367 return ether_addr_equal(addr1
, addr2
);
372 * ether_addr_equal_unaligned - Compare two not u16 aligned Ethernet addresses
373 * @addr1: Pointer to a six-byte array containing the Ethernet address
374 * @addr2: Pointer other six-byte array containing the Ethernet address
376 * Compare two Ethernet addresses, returns true if equal
378 * Please note: Use only when any Ethernet address may not be u16 aligned.
380 static inline bool ether_addr_equal_unaligned(const u8
*addr1
, const u8
*addr2
)
382 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
383 return ether_addr_equal(addr1
, addr2
);
385 return memcmp(addr1
, addr2
, ETH_ALEN
) == 0;
390 * ether_addr_equal_masked - Compare two Ethernet addresses with a mask
391 * @addr1: Pointer to a six-byte array containing the 1st Ethernet address
392 * @addr2: Pointer to a six-byte array containing the 2nd Ethernet address
393 * @mask: Pointer to a six-byte array containing the Ethernet address bitmask
395 * Compare two Ethernet addresses with a mask, returns true if for every bit
396 * set in the bitmask the equivalent bits in the ethernet addresses are equal.
397 * Using a mask with all bits set is a slower ether_addr_equal.
399 static inline bool ether_addr_equal_masked(const u8
*addr1
, const u8
*addr2
,
404 for (i
= 0; i
< ETH_ALEN
; i
++) {
405 if ((addr1
[i
] ^ addr2
[i
]) & mask
[i
])
413 * ether_addr_to_u64 - Convert an Ethernet address into a u64 value.
414 * @addr: Pointer to a six-byte array containing the Ethernet address
416 * Return a u64 value of the address
418 static inline u64
ether_addr_to_u64(const u8
*addr
)
423 for (i
= 0; i
< ETH_ALEN
; i
++)
424 u
= u
<< 8 | addr
[i
];
430 * u64_to_ether_addr - Convert a u64 to an Ethernet address.
431 * @u: u64 to convert to an Ethernet MAC address
432 * @addr: Pointer to a six-byte array to contain the Ethernet address
434 static inline void u64_to_ether_addr(u64 u
, u8
*addr
)
438 for (i
= ETH_ALEN
- 1; i
>= 0; i
--) {
445 * eth_addr_dec - Decrement the given MAC address
447 * @addr: Pointer to a six-byte array containing Ethernet address to decrement
449 static inline void eth_addr_dec(u8
*addr
)
451 u64 u
= ether_addr_to_u64(addr
);
454 u64_to_ether_addr(u
, addr
);
458 * eth_addr_inc() - Increment the given MAC address.
459 * @addr: Pointer to a six-byte array containing Ethernet address to increment.
461 static inline void eth_addr_inc(u8
*addr
)
463 u64 u
= ether_addr_to_u64(addr
);
466 u64_to_ether_addr(u
, addr
);
470 * is_etherdev_addr - Tell if given Ethernet address belongs to the device.
471 * @dev: Pointer to a device structure
472 * @addr: Pointer to a six-byte array containing the Ethernet address
474 * Compare passed address with all addresses of the device. Return true if the
475 * address if one of the device addresses.
477 * Note that this function calls ether_addr_equal_64bits() so take care of
480 static inline bool is_etherdev_addr(const struct net_device
*dev
,
481 const u8 addr
[6 + 2])
483 struct netdev_hw_addr
*ha
;
487 for_each_dev_addr(dev
, ha
) {
488 res
= ether_addr_equal_64bits(addr
, ha
->addr
);
495 #endif /* __KERNEL__ */
498 * compare_ether_header - Compare two Ethernet headers
499 * @a: Pointer to Ethernet header
500 * @b: Pointer to Ethernet header
502 * Compare two Ethernet headers, returns 0 if equal.
503 * This assumes that the network header (i.e., IP header) is 4-byte
504 * aligned OR the platform can handle unaligned access. This is the
505 * case for all packets coming into netif_receive_skb or similar
509 static inline unsigned long compare_ether_header(const void *a
, const void *b
)
511 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
515 * We want to compare 14 bytes:
516 * [a0 ... a13] ^ [b0 ... b13]
517 * Use two long XOR, ORed together, with an overlap of two bytes.
518 * [a0 a1 a2 a3 a4 a5 a6 a7 ] ^ [b0 b1 b2 b3 b4 b5 b6 b7 ] |
519 * [a6 a7 a8 a9 a10 a11 a12 a13] ^ [b6 b7 b8 b9 b10 b11 b12 b13]
520 * This means the [a6 a7] ^ [b6 b7] part is done two times.
522 fold
= *(unsigned long *)a
^ *(unsigned long *)b
;
523 fold
|= *(unsigned long *)(a
+ 6) ^ *(unsigned long *)(b
+ 6);
526 u32
*a32
= (u32
*)((u8
*)a
+ 2);
527 u32
*b32
= (u32
*)((u8
*)b
+ 2);
529 return (*(u16
*)a
^ *(u16
*)b
) | (a32
[0] ^ b32
[0]) |
530 (a32
[1] ^ b32
[1]) | (a32
[2] ^ b32
[2]);
535 * eth_skb_pad - Pad buffer to mininum number of octets for Ethernet frame
536 * @skb: Buffer to pad
538 * An Ethernet frame should have a minimum size of 60 bytes. This function
539 * takes short frames and pads them with zeros up to the 60 byte limit.
541 static inline int eth_skb_pad(struct sk_buff
*skb
)
543 return skb_put_padto(skb
, ETH_ZLEN
);
546 #endif /* _LINUX_ETHERDEVICE_H */