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>
31 extern __be16
eth_type_trans(struct sk_buff
*skb
, struct net_device
*dev
);
32 extern const struct header_ops eth_header_ops
;
34 extern int eth_header(struct sk_buff
*skb
, struct net_device
*dev
,
36 const void *daddr
, const void *saddr
, unsigned len
);
37 extern int eth_rebuild_header(struct sk_buff
*skb
);
38 extern int eth_header_parse(const struct sk_buff
*skb
, unsigned char *haddr
);
39 extern int eth_header_cache(const struct neighbour
*neigh
, struct hh_cache
*hh
, __be16 type
);
40 extern void eth_header_cache_update(struct hh_cache
*hh
,
41 const struct net_device
*dev
,
42 const unsigned char *haddr
);
43 extern int eth_mac_addr(struct net_device
*dev
, void *p
);
44 extern int eth_change_mtu(struct net_device
*dev
, int new_mtu
);
45 extern int eth_validate_addr(struct net_device
*dev
);
49 extern 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)
55 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
56 * @addr: Pointer to a six-byte array containing the Ethernet address
58 * Return true if the address is all zeroes.
60 static inline bool is_zero_ether_addr(const u8
*addr
)
62 return !(addr
[0] | addr
[1] | addr
[2] | addr
[3] | addr
[4] | addr
[5]);
66 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
67 * @addr: Pointer to a six-byte array containing the Ethernet address
69 * Return true if the address is a multicast address.
70 * By definition the broadcast address is also a multicast address.
72 static inline bool is_multicast_ether_addr(const u8
*addr
)
74 return 0x01 & addr
[0];
78 * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802).
79 * @addr: Pointer to a six-byte array containing the Ethernet address
81 * Return true if the address is a local address.
83 static inline bool is_local_ether_addr(const u8
*addr
)
85 return 0x02 & addr
[0];
89 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
90 * @addr: Pointer to a six-byte array containing the Ethernet address
92 * Return true if the address is the broadcast address.
94 static inline bool is_broadcast_ether_addr(const u8
*addr
)
96 return (addr
[0] & addr
[1] & addr
[2] & addr
[3] & addr
[4] & addr
[5]) == 0xff;
100 * is_unicast_ether_addr - Determine if the Ethernet address is unicast
101 * @addr: Pointer to a six-byte array containing the Ethernet address
103 * Return true if the address is a unicast address.
105 static inline bool is_unicast_ether_addr(const u8
*addr
)
107 return !is_multicast_ether_addr(addr
);
111 * is_valid_ether_addr - Determine if the given Ethernet address is valid
112 * @addr: Pointer to a six-byte array containing the Ethernet address
114 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
115 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
117 * Return true if the address is valid.
119 static inline bool is_valid_ether_addr(const u8
*addr
)
121 /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
122 * explicitly check for it here. */
123 return !is_multicast_ether_addr(addr
) && !is_zero_ether_addr(addr
);
127 * random_ether_addr - Generate software assigned random Ethernet address
128 * @addr: Pointer to a six-byte array containing the Ethernet address
130 * Generate a random Ethernet address (MAC) that is not multicast
131 * and has the local assigned bit set.
133 static inline void random_ether_addr(u8
*addr
)
135 get_random_bytes (addr
, ETH_ALEN
);
136 addr
[0] &= 0xfe; /* clear multicast bit */
137 addr
[0] |= 0x02; /* set local assignment bit (IEEE802) */
141 * eth_hw_addr_random - Generate software assigned random Ethernet and
143 * @dev: pointer to net_device structure
145 * Generate a random Ethernet address (MAC) to be used by a net device
146 * and set addr_assign_type so the state can be read by sysfs and be
149 static inline void eth_hw_addr_random(struct net_device
*dev
)
151 dev
->addr_assign_type
|= NET_ADDR_RANDOM
;
152 random_ether_addr(dev
->dev_addr
);
156 * compare_ether_addr - Compare two Ethernet addresses
157 * @addr1: Pointer to a six-byte array containing the Ethernet address
158 * @addr2: Pointer other six-byte array containing the Ethernet address
160 * Compare two Ethernet addresses, returns 0 if equal, non-zero otherwise.
161 * Unlike memcmp(), it doesn't return a value suitable for sorting.
163 static inline unsigned compare_ether_addr(const u8
*addr1
, const u8
*addr2
)
165 const u16
*a
= (const u16
*) addr1
;
166 const u16
*b
= (const u16
*) addr2
;
168 BUILD_BUG_ON(ETH_ALEN
!= 6);
169 return ((a
[0] ^ b
[0]) | (a
[1] ^ b
[1]) | (a
[2] ^ b
[2])) != 0;
173 * ether_addr_equal - Compare two Ethernet addresses
174 * @addr1: Pointer to a six-byte array containing the Ethernet address
175 * @addr2: Pointer other six-byte array containing the Ethernet address
177 * Compare two Ethernet addresses, returns true if equal
179 static inline bool ether_addr_equal(const u8
*addr1
, const u8
*addr2
)
181 return !compare_ether_addr(addr1
, addr2
);
184 static inline unsigned long zap_last_2bytes(unsigned long value
)
194 * ether_addr_equal_64bits - Compare two Ethernet addresses
195 * @addr1: Pointer to an array of 8 bytes
196 * @addr2: Pointer to an other array of 8 bytes
198 * Compare two Ethernet addresses, returns true if equal, false otherwise.
200 * The function doesn't need any conditional branches and possibly uses
201 * word memory accesses on CPU allowing cheap unaligned memory reads.
202 * arrays = { byte1, byte2, byte3, byte4, byte5, byte6, pad1, pad2 }
204 * Please note that alignment of addr1 & addr2 are only guaranteed to be 16 bits.
207 static inline bool ether_addr_equal_64bits(const u8 addr1
[6+2],
210 #ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
211 unsigned long fold
= ((*(unsigned long *)addr1
) ^
212 (*(unsigned long *)addr2
));
214 if (sizeof(fold
) == 8)
215 return zap_last_2bytes(fold
) == 0;
217 fold
|= zap_last_2bytes((*(unsigned long *)(addr1
+ 4)) ^
218 (*(unsigned long *)(addr2
+ 4)));
221 return ether_addr_equal(addr1
, addr2
);
226 * is_etherdev_addr - Tell if given Ethernet address belongs to the device.
227 * @dev: Pointer to a device structure
228 * @addr: Pointer to a six-byte array containing the Ethernet address
230 * Compare passed address with all addresses of the device. Return true if the
231 * address if one of the device addresses.
233 * Note that this function calls ether_addr_equal_64bits() so take care of
236 static inline bool is_etherdev_addr(const struct net_device
*dev
,
237 const u8 addr
[6 + 2])
239 struct netdev_hw_addr
*ha
;
243 for_each_dev_addr(dev
, ha
) {
244 res
= ether_addr_equal_64bits(addr
, ha
->addr
);
251 #endif /* __KERNEL__ */
254 * compare_ether_header - Compare two Ethernet headers
255 * @a: Pointer to Ethernet header
256 * @b: Pointer to Ethernet header
258 * Compare two Ethernet headers, returns 0 if equal.
259 * This assumes that the network header (i.e., IP header) is 4-byte
260 * aligned OR the platform can handle unaligned access. This is the
261 * case for all packets coming into netif_receive_skb or similar
265 static inline unsigned long compare_ether_header(const void *a
, const void *b
)
267 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
271 * We want to compare 14 bytes:
272 * [a0 ... a13] ^ [b0 ... b13]
273 * Use two long XOR, ORed together, with an overlap of two bytes.
274 * [a0 a1 a2 a3 a4 a5 a6 a7 ] ^ [b0 b1 b2 b3 b4 b5 b6 b7 ] |
275 * [a6 a7 a8 a9 a10 a11 a12 a13] ^ [b6 b7 b8 b9 b10 b11 b12 b13]
276 * This means the [a6 a7] ^ [b6 b7] part is done two times.
278 fold
= *(unsigned long *)a
^ *(unsigned long *)b
;
279 fold
|= *(unsigned long *)(a
+ 6) ^ *(unsigned long *)(b
+ 6);
282 u32
*a32
= (u32
*)((u8
*)a
+ 2);
283 u32
*b32
= (u32
*)((u8
*)b
+ 2);
285 return (*(u16
*)a
^ *(u16
*)b
) | (a32
[0] ^ b32
[0]) |
286 (a32
[1] ^ b32
[1]) | (a32
[2] ^ b32
[2]);
290 #endif /* _LINUX_ETHERDEVICE_H */