include/linux/etherdevice.h

   1 /*
   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  *
  10  * Authors:     Ross Biro
  11  *              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>
  28 #include <linux/netdevice.h>
  29 #include <linux/random.h>
  30 #include <asm/unaligned.h>
  31
  32 #ifdef __KERNEL__
  33 extern __be16           eth_type_trans(struct sk_buff *skb, struct net_device *dev);
  34 extern const struct header_ops eth_header_ops;
  35
  36 extern int eth_header(struct sk_buff *skb, struct net_device *dev,
  37                       unsigned short type,
  38                       const void *daddr, const void *saddr, unsigned len);
  39 extern int eth_rebuild_header(struct sk_buff *skb);
  40 extern int eth_header_parse(const struct sk_buff *skb, unsigned char *haddr);
  41 extern int eth_header_cache(const struct neighbour *neigh, struct hh_cache *hh, __be16 type);
  42 extern void eth_header_cache_update(struct hh_cache *hh,
  43                                     const struct net_device *dev,
  44                                     const unsigned char *haddr);
  45 extern int eth_mac_addr(struct net_device *dev, void *p);
  46 extern int eth_change_mtu(struct net_device *dev, int new_mtu);
  47 extern int eth_validate_addr(struct net_device *dev);
  48
  49
  50
  51 extern struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs,
  52                                             unsigned int rxqs);
  53 #define alloc_etherdev(sizeof_priv) alloc_etherdev_mq(sizeof_priv, 1)
  54 #define alloc_etherdev_mq(sizeof_priv, count) alloc_etherdev_mqs(sizeof_priv, count, count)
  55
  56 /**
  57  * 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.
  61  */
  62 static inline bool is_zero_ether_addr(const u8 *addr)
  63 {
  64         return !(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]);
  65 }
  66
  67 /**
  68  * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
  69  * @addr: Pointer to a six-byte array containing the Ethernet address
  70  *
  71  * Return true if the address is a multicast address.
  72  * By definition the broadcast address is also a multicast address.
  73  */
  74 static inline bool is_multicast_ether_addr(const u8 *addr)
  75 {
  76         return 0x01 & addr[0];
  77 }
  78
  79 /**
  80  * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802).
  81  * @addr: Pointer to a six-byte array containing the Ethernet address
  82  *
  83  * Return true if the address is a local address.
  84  */
  85 static inline bool is_local_ether_addr(const u8 *addr)
  86 {
  87         return 0x02 & addr[0];
  88 }
  89
  90 /**
  91  * 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  */
  96 static inline bool is_broadcast_ether_addr(const u8 *addr)
  97 {
  98         return (addr[0] & addr[1] & addr[2] & addr[3] & addr[4] & addr[5]) == 0xff;
  99 }
 100
 101 /**
 102  * 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  */
 107 static inline bool is_unicast_ether_addr(const u8 *addr)
 108 {
 109         return !is_multicast_ether_addr(addr);
 110 }
 111
 112 /**
 113  * 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
 117  * a multicast address, and is not FF:FF:FF:FF:FF:FF.
 118  *
 119  * Return true if the address is valid.
 120  */
 121 static inline bool is_valid_ether_addr(const u8 *addr)
 122 {
 123         /* 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);
 126 }
 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  */
 135 static 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 }
 141
 142 /**
 143  * eth_hw_addr_random - Generate software assigned random Ethernet and
 144  * set device flag
 145  * @dev: pointer to net_device structure
 146  *
 147  * 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.
 150  */
 151 static inline void eth_hw_addr_random(struct net_device *dev)
 152 {
 153         dev->addr_assign_type |= NET_ADDR_RANDOM;
 154         random_ether_addr(dev->dev_addr);
 155 }
 156
 157 /**
 158  * compare_ether_addr - Compare two Ethernet addresses
 159  * @addr1: Pointer to a six-byte array containing the Ethernet address
 160  * @addr2: Pointer other six-byte array containing the Ethernet address
 161  *
 162  * Compare two ethernet addresses, returns 0 if equal, non-zero otherwise.
 163  * Unlike memcmp(), it doesn't return a value suitable for sorting.
 164  */
 165 static inline unsigned compare_ether_addr(const u8 *addr1, const u8 *addr2)
 166 {
 167         const u16 *a = (const u16 *) addr1;
 168         const u16 *b = (const u16 *) addr2;
 169
 170         BUILD_BUG_ON(ETH_ALEN != 6);
 171         return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) != 0;
 172 }
 173
 174 /**
 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  */
 181 static inline bool ether_addr_equal(const u8 *addr1, const u8 *addr2)
 182 {
 183         return !compare_ether_addr(addr1, addr2);
 184 }
 185
 186 static 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 /**
 196  * compare_ether_addr_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 0 if equal, non-zero otherwise.
 201  * Unlike memcmp(), it doesn't return a value suitable for sorting.
 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
 209 static inline unsigned compare_ether_addr_64bits(const u8 addr1[6+2],
 210                                                  const u8 addr2[6+2])
 211 {
 212 #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 compare_ether_addr(addr1, addr2);
 224 #endif
 225 }
 226
 227 /**
 228  * 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  *
 235  * Note that this function calls compare_ether_addr_64bits() so take care of
 236  * the right padding.
 237  */
 238 static inline bool is_etherdev_addr(const struct net_device *dev,
 239                                     const u8 addr[6 + 2])
 240 {
 241         struct netdev_hw_addr *ha;
 242         int res = 1;
 243
 244         rcu_read_lock();
 245         for_each_dev_addr(dev, ha) {
 246                 res = compare_ether_addr_64bits(addr, ha->addr);
 247                 if (!res)
 248                         break;
 249         }
 250         rcu_read_unlock();
 251         return !res;
 252 }
 253 #endif  /* __KERNEL__ */
 254
 255 /**
 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
 267 static inline unsigned long compare_ether_header(const void *a, const void *b)
 268 {
 269 #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
 284         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]);
 289 #endif
 290 }
 291
 292 #endif  /* _LINUX_ETHERDEVICE_H */