blob: d426336d92d9e4bb34f5f049bc7f4f05d49303bb [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 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 */
22#ifndef _LINUX_ETHERDEVICE_H
23#define _LINUX_ETHERDEVICE_H
24
25#include <linux/if_ether.h>
Arnd Bergmannbcd61272005-06-28 15:58:50 -070026#include <linux/netdevice.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/random.h>
Eric Dumazet1f87e232008-11-23 23:24:32 -080028#include <asm/unaligned.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30#ifdef __KERNEL__
Alexey Dobriyanab611482005-07-12 12:08:43 -070031extern __be16 eth_type_trans(struct sk_buff *skb, struct net_device *dev);
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -070032extern const struct header_ops eth_header_ops;
33
34extern int eth_header(struct sk_buff *skb, struct net_device *dev,
35 unsigned short type,
36 const void *daddr, const void *saddr, unsigned len);
37extern int eth_rebuild_header(struct sk_buff *skb);
38extern int eth_header_parse(const struct sk_buff *skb, unsigned char *haddr);
David S. Millere69dd332011-07-12 23:28:12 -070039extern int eth_header_cache(const struct neighbour *neigh, struct hh_cache *hh, __be16 type);
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -070040extern void eth_header_cache_update(struct hh_cache *hh,
41 const struct net_device *dev,
42 const unsigned char *haddr);
Stephen Hemmingerccad6372008-11-19 22:42:31 -080043extern int eth_mac_addr(struct net_device *dev, void *p);
44extern int eth_change_mtu(struct net_device *dev, int new_mtu);
45extern int eth_validate_addr(struct net_device *dev);
46
Stephen Hemminger3b04ddd2007-10-09 01:40:57 -070047
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Tom Herbert36909ea2011-01-09 19:36:31 +000049extern struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs,
50 unsigned int rxqs);
Peter P Waskiewicz Jrf25f4e42007-07-06 13:36:20 -070051#define alloc_etherdev(sizeof_priv) alloc_etherdev_mq(sizeof_priv, 1)
Tom Herbert36909ea2011-01-09 19:36:31 +000052#define alloc_etherdev_mq(sizeof_priv, count) alloc_etherdev_mqs(sizeof_priv, count, count)
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
54/**
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080055 * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
56 * @addr: Pointer to a six-byte array containing the Ethernet address
57 *
58 * Return true if the address is all zeroes.
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 */
Joe Perchesb44907e2012-05-08 06:44:40 +000060static inline bool is_zero_ether_addr(const u8 *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070061{
62 return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
63}
64
65/**
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080066 * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
Michael Ellerman791651212005-05-29 20:24:30 -070067 * @addr: Pointer to a six-byte array containing the Ethernet address
68 *
69 * Return true if the address is a multicast address.
Stephen Hemminger88df8ef2006-01-03 15:25:45 -080070 * By definition the broadcast address is also a multicast address.
Michael Ellerman791651212005-05-29 20:24:30 -070071 */
Joe Perchesb44907e2012-05-08 06:44:40 +000072static inline bool is_multicast_ether_addr(const u8 *addr)
Michael Ellerman791651212005-05-29 20:24:30 -070073{
Eric Dumazeta02cec22010-09-22 20:43:57 +000074 return 0x01 & addr[0];
Michael Ellerman791651212005-05-29 20:24:30 -070075}
76
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080077/**
Randy Dunlapbc2cda12008-02-13 15:03:25 -080078 * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802).
Paolo 'Blaisorblade' Giarrussoe0247152007-05-06 14:51:13 -070079 * @addr: Pointer to a six-byte array containing the Ethernet address
80 *
81 * Return true if the address is a local address.
82 */
Joe Perchesb44907e2012-05-08 06:44:40 +000083static inline bool is_local_ether_addr(const u8 *addr)
Paolo 'Blaisorblade' Giarrussoe0247152007-05-06 14:51:13 -070084{
Eric Dumazeta02cec22010-09-22 20:43:57 +000085 return 0x02 & addr[0];
Paolo 'Blaisorblade' Giarrussoe0247152007-05-06 14:51:13 -070086}
87
88/**
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -080089 * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
90 * @addr: Pointer to a six-byte array containing the Ethernet address
91 *
92 * Return true if the address is the broadcast address.
93 */
Joe Perchesb44907e2012-05-08 06:44:40 +000094static inline bool is_broadcast_ether_addr(const u8 *addr)
Jeff Garzik9bd481f2005-06-28 01:46:35 -040095{
Stephen Hemminger24075342005-11-01 16:52:11 -080096 return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
Jeff Garzik9bd481f2005-06-28 01:46:35 -040097}
98
Michael Ellerman791651212005-05-29 20:24:30 -070099/**
Tobias Klauser51e7eed72011-01-12 22:14:56 +0000100 * is_unicast_ether_addr - Determine if the Ethernet address is unicast
101 * @addr: Pointer to a six-byte array containing the Ethernet address
102 *
103 * Return true if the address is a unicast address.
104 */
Joe Perchesb44907e2012-05-08 06:44:40 +0000105static inline bool is_unicast_ether_addr(const u8 *addr)
Tobias Klauser51e7eed72011-01-12 22:14:56 +0000106{
107 return !is_multicast_ether_addr(addr);
108}
109
110/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 * is_valid_ether_addr - Determine if the given Ethernet address is valid
112 * @addr: Pointer to a six-byte array containing the Ethernet address
113 *
114 * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
Michael Ellerman791651212005-05-29 20:24:30 -0700115 * a multicast address, and is not FF:FF:FF:FF:FF:FF.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 *
117 * Return true if the address is valid.
118 */
Joe Perchesb44907e2012-05-08 06:44:40 +0000119static inline bool is_valid_ether_addr(const u8 *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120{
Michael Ellerman791651212005-05-29 20:24:30 -0700121 /* 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124}
125
126/**
Joe Perches0a4dd592012-07-12 19:33:05 +0000127 * eth_random_addr - Generate software assigned random Ethernet address
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 * @addr: Pointer to a six-byte array containing the Ethernet address
129 *
130 * Generate a random Ethernet address (MAC) that is not multicast
131 * and has the local assigned bit set.
132 */
Joe Perches0a4dd592012-07-12 19:33:05 +0000133static inline void eth_random_addr(u8 *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134{
Joe Perches0a4dd592012-07-12 19:33:05 +0000135 get_random_bytes(addr, ETH_ALEN);
136 addr[0] &= 0xfe; /* clear multicast bit */
137 addr[0] |= 0x02; /* set local assignment bit (IEEE802) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138}
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700139
Joe Perches0a4dd592012-07-12 19:33:05 +0000140#define random_ether_addr(addr) eth_random_addr(addr)
141
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700142/**
Johannes Bergad7eee92012-07-10 06:18:44 +0000143 * eth_broadcast_addr - Assign broadcast address
144 * @addr: Pointer to a six-byte array containing the Ethernet address
145 *
146 * Assign the broadcast address to the given address array.
147 */
148static inline void eth_broadcast_addr(u8 *addr)
149{
150 memset(addr, 0xff, ETH_ALEN);
151}
152
153/**
Danny Kukawka1a0d6ae2012-02-09 09:48:54 +0000154 * eth_hw_addr_random - Generate software assigned random Ethernet and
155 * set device flag
Stefan Assmannc1f79422010-07-22 02:50:21 +0000156 * @dev: pointer to net_device structure
Stefan Assmannc1f79422010-07-22 02:50:21 +0000157 *
Danny Kukawka1a0d6ae2012-02-09 09:48:54 +0000158 * Generate a random Ethernet address (MAC) to be used by a net device
159 * and set addr_assign_type so the state can be read by sysfs and be
160 * used by userspace.
Stefan Assmannc1f79422010-07-22 02:50:21 +0000161 */
Danny Kukawka1a0d6ae2012-02-09 09:48:54 +0000162static inline void eth_hw_addr_random(struct net_device *dev)
Stefan Assmannc1f79422010-07-22 02:50:21 +0000163{
164 dev->addr_assign_type |= NET_ADDR_RANDOM;
Joe Perches0a4dd592012-07-12 19:33:05 +0000165 eth_random_addr(dev->dev_addr);
Stefan Assmannc1f79422010-07-22 02:50:21 +0000166}
167
168/**
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700169 * compare_ether_addr - Compare two Ethernet addresses
170 * @addr1: Pointer to a six-byte array containing the Ethernet address
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -0800171 * @addr2: Pointer other six-byte array containing the Ethernet address
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700172 *
stephen hemminger048b8992012-05-17 05:17:28 +0000173 * Compare two Ethernet addresses, returns 0 if equal, non-zero otherwise.
Johannes Berg1c430a72012-05-07 15:39:06 +0200174 * Unlike memcmp(), it doesn't return a value suitable for sorting.
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700175 */
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -0800176static inline unsigned compare_ether_addr(const u8 *addr1, const u8 *addr2)
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700177{
Stephen Hemmingerc2da8ac2005-11-01 17:05:09 -0800178 const u16 *a = (const u16 *) addr1;
179 const u16 *b = (const u16 *) addr2;
Stephen Hemminger360ac8e2005-10-25 15:03:41 -0700180
181 BUILD_BUG_ON(ETH_ALEN != 6);
182 return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) != 0;
183}
Eric Dumazet1f87e232008-11-23 23:24:32 -0800184
Joe Perchesa599b0f2012-05-08 18:56:45 +0000185/**
186 * ether_addr_equal - Compare two Ethernet addresses
187 * @addr1: Pointer to a six-byte array containing the Ethernet address
188 * @addr2: Pointer other six-byte array containing the Ethernet address
189 *
stephen hemminger048b8992012-05-17 05:17:28 +0000190 * Compare two Ethernet addresses, returns true if equal
Joe Perchesa599b0f2012-05-08 18:56:45 +0000191 */
192static inline bool ether_addr_equal(const u8 *addr1, const u8 *addr2)
193{
194 return !compare_ether_addr(addr1, addr2);
195}
196
Eric Dumazet1f87e232008-11-23 23:24:32 -0800197static inline unsigned long zap_last_2bytes(unsigned long value)
198{
199#ifdef __BIG_ENDIAN
200 return value >> 16;
201#else
202 return value << 16;
203#endif
204}
205
206/**
Joe Perchesbaf523c2012-05-09 17:04:03 +0000207 * ether_addr_equal_64bits - Compare two Ethernet addresses
208 * @addr1: Pointer to an array of 8 bytes
209 * @addr2: Pointer to an other array of 8 bytes
210 *
stephen hemminger048b8992012-05-17 05:17:28 +0000211 * Compare two Ethernet addresses, returns true if equal, false otherwise.
Joe Perchesbaf523c2012-05-09 17:04:03 +0000212 *
213 * The function doesn't need any conditional branches and possibly uses
214 * word memory accesses on CPU allowing cheap unaligned memory reads.
stephen hemminger048b8992012-05-17 05:17:28 +0000215 * arrays = { byte1, byte2, byte3, byte4, byte5, byte6, pad1, pad2 }
Joe Perchesbaf523c2012-05-09 17:04:03 +0000216 *
stephen hemminger048b8992012-05-17 05:17:28 +0000217 * Please note that alignment of addr1 & addr2 are only guaranteed to be 16 bits.
Joe Perchesbaf523c2012-05-09 17:04:03 +0000218 */
219
220static inline bool ether_addr_equal_64bits(const u8 addr1[6+2],
221 const u8 addr2[6+2])
222{
Joe Perchese550ba12012-05-11 12:21:06 +0000223#ifdef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
224 unsigned long fold = ((*(unsigned long *)addr1) ^
225 (*(unsigned long *)addr2));
226
227 if (sizeof(fold) == 8)
228 return zap_last_2bytes(fold) == 0;
229
230 fold |= zap_last_2bytes((*(unsigned long *)(addr1 + 4)) ^
231 (*(unsigned long *)(addr2 + 4)));
232 return fold == 0;
233#else
234 return ether_addr_equal(addr1, addr2);
235#endif
Joe Perchesbaf523c2012-05-09 17:04:03 +0000236}
237
238/**
Jiri Pirkof001fde2009-05-05 02:48:28 +0000239 * is_etherdev_addr - Tell if given Ethernet address belongs to the device.
240 * @dev: Pointer to a device structure
241 * @addr: Pointer to a six-byte array containing the Ethernet address
242 *
243 * Compare passed address with all addresses of the device. Return true if the
244 * address if one of the device addresses.
245 *
Joe Perchese550ba12012-05-11 12:21:06 +0000246 * Note that this function calls ether_addr_equal_64bits() so take care of
Jiri Pirkof001fde2009-05-05 02:48:28 +0000247 * the right padding.
248 */
249static inline bool is_etherdev_addr(const struct net_device *dev,
250 const u8 addr[6 + 2])
251{
252 struct netdev_hw_addr *ha;
Joe Perchese550ba12012-05-11 12:21:06 +0000253 bool res = false;
Jiri Pirkof001fde2009-05-05 02:48:28 +0000254
255 rcu_read_lock();
256 for_each_dev_addr(dev, ha) {
Joe Perchese550ba12012-05-11 12:21:06 +0000257 res = ether_addr_equal_64bits(addr, ha->addr);
258 if (res)
Jiri Pirkof001fde2009-05-05 02:48:28 +0000259 break;
260 }
261 rcu_read_unlock();
Joe Perchese550ba12012-05-11 12:21:06 +0000262 return res;
Jiri Pirkof001fde2009-05-05 02:48:28 +0000263}
Michael Ellerman791651212005-05-29 20:24:30 -0700264#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000266/**
267 * compare_ether_header - Compare two Ethernet headers
268 * @a: Pointer to Ethernet header
269 * @b: Pointer to Ethernet header
270 *
stephen hemminger048b8992012-05-17 05:17:28 +0000271 * Compare two Ethernet headers, returns 0 if equal.
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000272 * This assumes that the network header (i.e., IP header) is 4-byte
273 * aligned OR the platform can handle unaligned access. This is the
274 * case for all packets coming into netif_receive_skb or similar
275 * entry points.
276 */
277
Eric Dumazet40d08022010-08-26 22:03:08 -0700278static inline unsigned long compare_ether_header(const void *a, const void *b)
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000279{
Eric Dumazet40d08022010-08-26 22:03:08 -0700280#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
281 unsigned long fold;
282
283 /*
284 * We want to compare 14 bytes:
285 * [a0 ... a13] ^ [b0 ... b13]
286 * Use two long XOR, ORed together, with an overlap of two bytes.
287 * [a0 a1 a2 a3 a4 a5 a6 a7 ] ^ [b0 b1 b2 b3 b4 b5 b6 b7 ] |
288 * [a6 a7 a8 a9 a10 a11 a12 a13] ^ [b6 b7 b8 b9 b10 b11 b12 b13]
289 * This means the [a6 a7] ^ [b6 b7] part is done two times.
290 */
291 fold = *(unsigned long *)a ^ *(unsigned long *)b;
292 fold |= *(unsigned long *)(a + 6) ^ *(unsigned long *)(b + 6);
293 return fold;
294#else
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000295 u32 *a32 = (u32 *)((u8 *)a + 2);
296 u32 *b32 = (u32 *)((u8 *)b + 2);
297
298 return (*(u16 *)a ^ *(u16 *)b) | (a32[0] ^ b32[0]) |
299 (a32[1] ^ b32[1]) | (a32[2] ^ b32[2]);
Eric Dumazet40d08022010-08-26 22:03:08 -0700300#endif
Herbert Xuaa4b9f52009-02-08 18:00:37 +0000301}
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303#endif /* _LINUX_ETHERDEVICE_H */