blob: dc85c1d2173b6b1308956702713f6a012cbd13f7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 *
Jesper Juhl02c30a82005-05-05 16:16:16 -070010 * Authors: Ross Biro
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * 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>
Arnd Bergmannbcd61272005-06-28 15:58:50 -070028#include <linux/netdevice.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/random.h>
Eric Dumazet1f87e232008-11-23 23:24:32 -080030#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32#ifdef __KERNEL__
Alexey Dobriyanab611482005-07-12 12:08:43 -070033extern __be16 eth_type_trans(struct sk_buff *skb, struct net_device *dev);
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -070034extern const struct header_ops eth_header_ops;
35
36extern int eth_header(struct sk_buff *skb, struct net_device *dev,
37 unsigned short type,
38 const void *daddr, const void *saddr, unsigned len);
39extern int eth_rebuild_header(struct sk_buff *skb);
40extern int eth_header_parse(const struct sk_buff *skb, unsigned char *haddr);
David S. Millere69dd332011-07-12 23:28:12 -070041extern int eth_header_cache(const struct neighbour *neigh, struct hh_cache *hh, __be16 type);
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -070042extern void eth_header_cache_update(struct hh_cache *hh,
43 const struct net_device *dev,
44 const unsigned char *haddr);
Stephen Hemmingerccad6372008-11-19 22:42:31 -080045extern int eth_mac_addr(struct net_device *dev, void *p);
46extern int eth_change_mtu(struct net_device *dev, int new_mtu);
47extern int eth_validate_addr(struct net_device *dev);
48
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -070049
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Tom Herbert36909ea2011-01-09 19:36:31 +000051extern struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs,
52 unsigned int rxqs);
Peter P Waskiewicz Jrf25f4e42007-07-06 13:36:20 -070053#define alloc_etherdev(sizeof_priv) alloc_etherdev_mq(sizeof_priv, 1)
Tom Herbert36909ea2011-01-09 19:36:31 +000054#define alloc_etherdev_mq(sizeof_priv, count) alloc_etherdev_mqs(sizeof_priv, count, count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56/**
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080057 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 */
Joe Perchesb44907e2012-05-08 06:44:40 +000062static inline bool is_zero_ether_addr(const u8 *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063{
64 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
65}
66
67/**
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080068 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
Michael Ellerman791651212005-05-29 20:24:30 -070069 * @addr: Pointer to a six-byte array containing the Ethernet address
70 *
71 * Return true if the address is a multicast address.
Stephen Hemminger88df8ef2006-01-03 15:25:45 -080072 * By definition the broadcast address is also a multicast address.
Michael Ellerman791651212005-05-29 20:24:30 -070073 */
Joe Perchesb44907e2012-05-08 06:44:40 +000074static inline bool is_multicast_ether_addr(const u8 *addr)
Michael Ellerman791651212005-05-29 20:24:30 -070075{
Eric Dumazeta02cec22010-09-22 20:43:57 +000076 return 0x01 & addr[0];
Michael Ellerman791651212005-05-29 20:24:30 -070077}
78
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080079/**
Randy Dunlapbc2cda12008-02-13 15:03:25 -080080 * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802).
Paolo 'Blaisorblade' Giarrussoe0247152007-05-06 14:51:13 -070081 * @addr: Pointer to a six-byte array containing the Ethernet address
82 *
83 * Return true if the address is a local address.
84 */
Joe Perchesb44907e2012-05-08 06:44:40 +000085static inline bool is_local_ether_addr(const u8 *addr)
Paolo 'Blaisorblade' Giarrussoe0247152007-05-06 14:51:13 -070086{
Eric Dumazeta02cec22010-09-22 20:43:57 +000087 return 0x02 & addr[0];
Paolo 'Blaisorblade' Giarrussoe0247152007-05-06 14:51:13 -070088}
89
90/**
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080091 * 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 */
Joe Perchesb44907e2012-05-08 06:44:40 +000096static inline bool is_broadcast_ether_addr(const u8 *addr)
Jeff Garzik9bd481f2005-06-28 01:46:35 -040097{
Stephen Hemminger24075342005-11-01 16:52:11 -080098 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
Jeff Garzik9bd481f2005-06-28 01:46:35 -040099}
100
Michael Ellerman791651212005-05-29 20:24:30 -0700101/**
Tobias Klauser51e7eed72011-01-12 22:14:56 +0000102 * 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 */
Joe Perchesb44907e2012-05-08 06:44:40 +0000107static inline bool is_unicast_ether_addr(const u8 *addr)
Tobias Klauser51e7eed72011-01-12 22:14:56 +0000108{
109 return !is_multicast_ether_addr(addr);
110}
111
112/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 * 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
Michael Ellerman791651212005-05-29 20:24:30 -0700117 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 *
119 * Return true if the address is valid.
120 */
Joe Perchesb44907e2012-05-08 06:44:40 +0000121static inline bool is_valid_ether_addr(const u8 *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Michael Ellerman791651212005-05-29 20:24:30 -0700123 /* 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126}
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 */
135static 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}
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700141
142/**
Danny Kukawka1a0d6ae2012-02-09 09:48:54 +0000143 * eth_hw_addr_random - Generate software assigned random Ethernet and
144 * set device flag
Stefan Assmannc1f79422010-07-22 02:50:21 +0000145 * @dev: pointer to net_device structure
Stefan Assmannc1f79422010-07-22 02:50:21 +0000146 *
Danny Kukawka1a0d6ae2012-02-09 09:48:54 +0000147 * 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.
Stefan Assmannc1f79422010-07-22 02:50:21 +0000150 */
Danny Kukawka1a0d6ae2012-02-09 09:48:54 +0000151static inline void eth_hw_addr_random(struct net_device *dev)
Stefan Assmannc1f79422010-07-22 02:50:21 +0000152{
153 dev->addr_assign_type |= NET_ADDR_RANDOM;
Danny Kukawka1a0d6ae2012-02-09 09:48:54 +0000154 random_ether_addr(dev->dev_addr);
Stefan Assmannc1f79422010-07-22 02:50:21 +0000155}
156
157/**
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700158 * compare_ether_addr - Compare two Ethernet addresses
159 * @addr1: Pointer to a six-byte array containing the Ethernet address
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -0800160 * @addr2: Pointer other six-byte array containing the Ethernet address
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700161 *
Johannes Berg1c430a72012-05-07 15:39:06 +0200162 * Compare two ethernet addresses, returns 0 if equal, non-zero otherwise.
163 * Unlike memcmp(), it doesn't return a value suitable for sorting.
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700164 */
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -0800165static inline unsigned compare_ether_addr(const u8 *addr1, const u8 *addr2)
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700166{
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -0800167 const u16 *a = (const u16 *) addr1;
168 const u16 *b = (const u16 *) addr2;
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700169
170 BUILD_BUG_ON(ETH_ALEN != 6);
171 return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) != 0;
172}
Eric Dumazet1f87e232008-11-23 23:24:32 -0800173
Joe Perchesa599b0f2012-05-08 18:56:45 +0000174/**
175 * ether_addr_equal - Compare two Ethernet addresses
176 * @addr1: Pointer to a six-byte array containing the Ethernet address
177 * @addr2: Pointer other six-byte array containing the Ethernet address
178 *
179 * Compare two ethernet addresses, returns true if equal
180 */
181static inline bool ether_addr_equal(const u8 *addr1, const u8 *addr2)
182{
183 return !compare_ether_addr(addr1, addr2);
184}
185
Eric Dumazet1f87e232008-11-23 23:24:32 -0800186static inline unsigned long zap_last_2bytes(unsigned long value)
187{
188#ifdef __BIG_ENDIAN
189 return value >> 16;
190#else
191 return value << 16;
192#endif
193}
194
195/**
Joe Perchesbaf523c2012-05-09 17:04:03 +0000196 * ether_addr_equal_64bits - Compare two Ethernet addresses
197 * @addr1: Pointer to an array of 8 bytes
198 * @addr2: Pointer to an other array of 8 bytes
199 *
200 * Compare two ethernet addresses, returns true if equal, false otherwise.
201 *
202 * The function doesn't need any conditional branches and possibly uses
203 * word memory accesses on CPU allowing cheap unaligned memory reads.
204 * arrays = { byte1, byte2, byte3, byte4, byte6, byte7, pad1, pad2}
205 *
206 * Please note that alignment of addr1 & addr2 is only guaranted to be 16 bits.
207 */
208
209static inline bool ether_addr_equal_64bits(const u8 addr1[6+2],
210 const u8 addr2[6+2])
211{
Joe Perchese550ba12012-05-11 12:21:06 +0000212#ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
213 unsigned long fold = ((*(unsigned long *)addr1) ^
214 (*(unsigned long *)addr2));
215
216 if (sizeof(fold) == 8)
217 return zap_last_2bytes(fold) == 0;
218
219 fold |= zap_last_2bytes((*(unsigned long *)(addr1 + 4)) ^
220 (*(unsigned long *)(addr2 + 4)));
221 return fold == 0;
222#else
223 return ether_addr_equal(addr1, addr2);
224#endif
Joe Perchesbaf523c2012-05-09 17:04:03 +0000225}
226
227/**
Jiri Pirkof001fde2009-05-05 02:48:28 +0000228 * is_etherdev_addr - Tell if given Ethernet address belongs to the device.
229 * @dev: Pointer to a device structure
230 * @addr: Pointer to a six-byte array containing the Ethernet address
231 *
232 * Compare passed address with all addresses of the device. Return true if the
233 * address if one of the device addresses.
234 *
Joe Perchese550ba12012-05-11 12:21:06 +0000235 * Note that this function calls ether_addr_equal_64bits() so take care of
Jiri Pirkof001fde2009-05-05 02:48:28 +0000236 * the right padding.
237 */
238static inline bool is_etherdev_addr(const struct net_device *dev,
239 const u8 addr[6 + 2])
240{
241 struct netdev_hw_addr *ha;
Joe Perchese550ba12012-05-11 12:21:06 +0000242 bool res = false;
Jiri Pirkof001fde2009-05-05 02:48:28 +0000243
244 rcu_read_lock();
245 for_each_dev_addr(dev, ha) {
Joe Perchese550ba12012-05-11 12:21:06 +0000246 res = ether_addr_equal_64bits(addr, ha->addr);
247 if (res)
Jiri Pirkof001fde2009-05-05 02:48:28 +0000248 break;
249 }
250 rcu_read_unlock();
Joe Perchese550ba12012-05-11 12:21:06 +0000251 return res;
Jiri Pirkof001fde2009-05-05 02:48:28 +0000252}
Michael Ellerman791651212005-05-29 20:24:30 -0700253#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000255/**
256 * compare_ether_header - Compare two Ethernet headers
257 * @a: Pointer to Ethernet header
258 * @b: Pointer to Ethernet header
259 *
260 * Compare two ethernet headers, returns 0 if equal.
261 * This assumes that the network header (i.e., IP header) is 4-byte
262 * aligned OR the platform can handle unaligned access. This is the
263 * case for all packets coming into netif_receive_skb or similar
264 * entry points.
265 */
266
Eric Dumazet40d08022010-08-26 22:03:08 -0700267static inline unsigned long compare_ether_header(const void *a, const void *b)
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000268{
Eric Dumazet40d08022010-08-26 22:03:08 -0700269#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
270 unsigned long fold;
271
272 /*
273 * We want to compare 14 bytes:
274 * [a0 ... a13] ^ [b0 ... b13]
275 * Use two long XOR, ORed together, with an overlap of two bytes.
276 * [a0 a1 a2 a3 a4 a5 a6 a7 ] ^ [b0 b1 b2 b3 b4 b5 b6 b7 ] |
277 * [a6 a7 a8 a9 a10 a11 a12 a13] ^ [b6 b7 b8 b9 b10 b11 b12 b13]
278 * This means the [a6 a7] ^ [b6 b7] part is done two times.
279 */
280 fold = *(unsigned long *)a ^ *(unsigned long *)b;
281 fold |= *(unsigned long *)(a + 6) ^ *(unsigned long *)(b + 6);
282 return fold;
283#else
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000284 u32 *a32 = (u32 *)((u8 *)a + 2);
285 u32 *b32 = (u32 *)((u8 *)b + 2);
286
287 return (*(u16 *)a ^ *(u16 *)b) | (a32[0] ^ b32[0]) |
288 (a32[1] ^ b32[1]) | (a32[2] ^ b32[2]);
Eric Dumazet40d08022010-08-26 22:03:08 -0700289#endif
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000290}
291
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292#endif /* _LINUX_ETHERDEVICE_H */