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  */
  22 #ifndef _LINUX_ETHERDEVICE_H
  23 #define _LINUX_ETHERDEVICE_H
  24
  25 #include <linux/if_ether.h>
  26 #include <linux/netdevice.h>
  27 #include <linux/random.h>
  28 #include <asm/unaligned.h>
  29 #include <asm/bitsperlong.h>
  30
  31 #ifdef __KERNEL__
  32 u32 eth_get_headlen(void *data, unsigned int max_len);
  33 __be16 eth_type_trans(struct sk_buff *skb, struct net_device *dev);
  34 extern const struct header_ops eth_header_ops;
  35
  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,
  40                      __be16 type);
  41 void eth_header_cache_update(struct hh_cache *hh, const struct net_device *dev,
  42                              const unsigned char *haddr);
  43 int eth_prepare_mac_addr_change(struct net_device *dev, void *p);
  44 void eth_commit_mac_addr_change(struct net_device *dev, void *p);
  45 int eth_mac_addr(struct net_device *dev, void *p);
  46 int eth_change_mtu(struct net_device *dev, int new_mtu);
  47 int eth_validate_addr(struct net_device *dev);
  48
  49 struct net_device *alloc_etherdev_mqs(int sizeof_priv, unsigned int txqs,
  50                                             unsigned int rxqs);
  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)
  53
  54 struct sk_buff **eth_gro_receive(struct sk_buff **head,
  55                                  struct sk_buff *skb);
  56 int eth_gro_complete(struct sk_buff *skb, int nhoff);
  57
  58 /* Reserved Ethernet Addresses per IEEE 802.1Q */
  59 static const u8 eth_reserved_addr_base[ETH_ALEN] __aligned(2) =
  60 { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x00 };
  61
  62 /**
  63  * is_link_local_ether_addr - Determine if given Ethernet address is link-local
  64  * @addr: Pointer to a six-byte array containing the Ethernet address
  65  *
  66  * Return true if address is link local reserved addr (01:80:c2:00:00:0X) per
  67  * IEEE 802.1Q 8.6.3 Frame filtering.
  68  *
  69  * Please note: addr must be aligned to u16.
  70  */
  71 static inline bool is_link_local_ether_addr(const u8 *addr)
  72 {
  73         __be16 *a = (__be16 *)addr;
  74         static const __be16 *b = (const __be16 *)eth_reserved_addr_base;
  75         static const __be16 m = cpu_to_be16(0xfff0);
  76
  77 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
  78         return (((*(const u32 *)addr) ^ (*(const u32 *)b)) |
  79                 (__force int)((a[2] ^ b[2]) & m)) == 0;
  80 #else
  81         return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | ((a[2] ^ b[2]) & m)) == 0;
  82 #endif
  83 }
  84
  85 /**
  86  * is_zero_ether_addr - Determine if give Ethernet address is all zeros.
  87  * @addr: Pointer to a six-byte array containing the Ethernet address
  88  *
  89  * Return true if the address is all zeroes.
  90  *
  91  * Please note: addr must be aligned to u16.
  92  */
  93 static inline bool is_zero_ether_addr(const u8 *addr)
  94 {
  95 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
  96         return ((*(const u32 *)addr) | (*(const u16 *)(addr + 4))) == 0;
  97 #else
  98         return (*(const u16 *)(addr + 0) |
  99                 *(const u16 *)(addr + 2) |
 100                 *(const u16 *)(addr + 4)) == 0;
 101 #endif
 102 }
 103
 104 /**
 105  * is_multicast_ether_addr - Determine if the Ethernet address is a multicast.
 106  * @addr: Pointer to a six-byte array containing the Ethernet address
 107  *
 108  * Return true if the address is a multicast address.
 109  * By definition the broadcast address is also a multicast address.
 110  */
 111 static inline bool is_multicast_ether_addr(const u8 *addr)
 112 {
 113 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
 114         u32 a = *(const u32 *)addr;
 115 #else
 116         u16 a = *(const u16 *)addr;
 117 #endif
 118 #ifdef __BIG_ENDIAN
 119         return 0x01 & (a >> ((sizeof(a) * 8) - 8));
 120 #else
 121         return 0x01 & a;
 122 #endif
 123 }
 124
 125 static inline bool is_multicast_ether_addr_64bits(const u8 addr[6+2])
 126 {
 127 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
 128 #ifdef __BIG_ENDIAN
 129         return 0x01 & ((*(const u64 *)addr) >> 56);
 130 #else
 131         return 0x01 & (*(const u64 *)addr);
 132 #endif
 133 #else
 134         return is_multicast_ether_addr(addr);
 135 #endif
 136 }
 137
 138 /**
 139  * is_local_ether_addr - Determine if the Ethernet address is locally-assigned one (IEEE 802).
 140  * @addr: Pointer to a six-byte array containing the Ethernet address
 141  *
 142  * Return true if the address is a local address.
 143  */
 144 static inline bool is_local_ether_addr(const u8 *addr)
 145 {
 146         return 0x02 & addr[0];
 147 }
 148
 149 /**
 150  * is_broadcast_ether_addr - Determine if the Ethernet address is broadcast
 151  * @addr: Pointer to a six-byte array containing the Ethernet address
 152  *
 153  * Return true if the address is the broadcast address.
 154  *
 155  * Please note: addr must be aligned to u16.
 156  */
 157 static inline bool is_broadcast_ether_addr(const u8 *addr)
 158 {
 159         return (*(const u16 *)(addr + 0) &
 160                 *(const u16 *)(addr + 2) &
 161                 *(const u16 *)(addr + 4)) == 0xffff;
 162 }
 163
 164 /**
 165  * is_unicast_ether_addr - Determine if the Ethernet address is unicast
 166  * @addr: Pointer to a six-byte array containing the Ethernet address
 167  *
 168  * Return true if the address is a unicast address.
 169  */
 170 static inline bool is_unicast_ether_addr(const u8 *addr)
 171 {
 172         return !is_multicast_ether_addr(addr);
 173 }
 174
 175 /**
 176  * is_valid_ether_addr - Determine if the given Ethernet address is valid
 177  * @addr: Pointer to a six-byte array containing the Ethernet address
 178  *
 179  * Check that the Ethernet address (MAC) is not 00:00:00:00:00:00, is not
 180  * a multicast address, and is not FF:FF:FF:FF:FF:FF.
 181  *
 182  * Return true if the address is valid.
 183  *
 184  * Please note: addr must be aligned to u16.
 185  */
 186 static inline bool is_valid_ether_addr(const u8 *addr)
 187 {
 188         /* FF:FF:FF:FF:FF:FF is a multicast address so we don't need to
 189          * explicitly check for it here. */
 190         return !is_multicast_ether_addr(addr) && !is_zero_ether_addr(addr);
 191 }
 192
 193 /**
 194  * eth_proto_is_802_3 - Determine if a given Ethertype/length is a protocol
 195  * @proto: Ethertype/length value to be tested
 196  *
 197  * Check that the value from the Ethertype/length field is a valid Ethertype.
 198  *
 199  * Return true if the valid is an 802.3 supported Ethertype.
 200  */
 201 static inline bool eth_proto_is_802_3(__be16 proto)
 202 {
 203 #ifndef __BIG_ENDIAN
 204         /* if CPU is little endian mask off bits representing LSB */
 205         proto &= htons(0xFF00);
 206 #endif
 207         /* cast both to u16 and compare since LSB can be ignored */
 208         return (__force u16)proto >= (__force u16)htons(ETH_P_802_3_MIN);
 209 }
 210
 211 /**
 212  * eth_random_addr - Generate software assigned random Ethernet address
 213  * @addr: Pointer to a six-byte array containing the Ethernet address
 214  *
 215  * Generate a random Ethernet address (MAC) that is not multicast
 216  * and has the local assigned bit set.
 217  */
 218 static inline void eth_random_addr(u8 *addr)
 219 {
 220         get_random_bytes(addr, ETH_ALEN);
 221         addr[0] &= 0xfe;        /* clear multicast bit */
 222         addr[0] |= 0x02;        /* set local assignment bit (IEEE802) */
 223 }
 224
 225 #define random_ether_addr(addr) eth_random_addr(addr)
 226
 227 /**
 228  * eth_broadcast_addr - Assign broadcast address
 229  * @addr: Pointer to a six-byte array containing the Ethernet address
 230  *
 231  * Assign the broadcast address to the given address array.
 232  */
 233 static inline void eth_broadcast_addr(u8 *addr)
 234 {
 235         memset(addr, 0xff, ETH_ALEN);
 236 }
 237
 238 /**
 239  * eth_zero_addr - Assign zero address
 240  * @addr: Pointer to a six-byte array containing the Ethernet address
 241  *
 242  * Assign the zero address to the given address array.
 243  */
 244 static inline void eth_zero_addr(u8 *addr)
 245 {
 246         memset(addr, 0x00, ETH_ALEN);
 247 }
 248
 249 /**
 250  * eth_hw_addr_random - Generate software assigned random Ethernet and
 251  * set device flag
 252  * @dev: pointer to net_device structure
 253  *
 254  * Generate a random Ethernet address (MAC) to be used by a net device
 255  * and set addr_assign_type so the state can be read by sysfs and be
 256  * used by userspace.
 257  */
 258 static inline void eth_hw_addr_random(struct net_device *dev)
 259 {
 260         dev->addr_assign_type = NET_ADDR_RANDOM;
 261         eth_random_addr(dev->dev_addr);
 262 }
 263
 264 /**
 265  * ether_addr_copy - Copy an Ethernet address
 266  * @dst: Pointer to a six-byte array Ethernet address destination
 267  * @src: Pointer to a six-byte array Ethernet address source
 268  *
 269  * Please note: dst & src must both be aligned to u16.
 270  */
 271 static inline void ether_addr_copy(u8 *dst, const u8 *src)
 272 {
 273 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
 274         *(u32 *)dst = *(const u32 *)src;
 275         *(u16 *)(dst + 4) = *(const u16 *)(src + 4);
 276 #else
 277         u16 *a = (u16 *)dst;
 278         const u16 *b = (const u16 *)src;
 279
 280         a[0] = b[0];
 281         a[1] = b[1];
 282         a[2] = b[2];
 283 #endif
 284 }
 285
 286 /**
 287  * eth_hw_addr_inherit - Copy dev_addr from another net_device
 288  * @dst: pointer to net_device to copy dev_addr to
 289  * @src: pointer to net_device to copy dev_addr from
 290  *
 291  * Copy the Ethernet address from one net_device to another along with
 292  * the address attributes (addr_assign_type).
 293  */
 294 static inline void eth_hw_addr_inherit(struct net_device *dst,
 295                                        struct net_device *src)
 296 {
 297         dst->addr_assign_type = src->addr_assign_type;
 298         ether_addr_copy(dst->dev_addr, src->dev_addr);
 299 }
 300
 301 /**
 302  * ether_addr_equal - Compare two Ethernet addresses
 303  * @addr1: Pointer to a six-byte array containing the Ethernet address
 304  * @addr2: Pointer other six-byte array containing the Ethernet address
 305  *
 306  * Compare two Ethernet addresses, returns true if equal
 307  *
 308  * Please note: addr1 & addr2 must both be aligned to u16.
 309  */
 310 static inline bool ether_addr_equal(const u8 *addr1, const u8 *addr2)
 311 {
 312 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
 313         u32 fold = ((*(const u32 *)addr1) ^ (*(const u32 *)addr2)) |
 314                    ((*(const u16 *)(addr1 + 4)) ^ (*(const u16 *)(addr2 + 4)));
 315
 316         return fold == 0;
 317 #else
 318         const u16 *a = (const u16 *)addr1;
 319         const u16 *b = (const u16 *)addr2;
 320
 321         return ((a[0] ^ b[0]) | (a[1] ^ b[1]) | (a[2] ^ b[2])) == 0;
 322 #endif
 323 }
 324
 325 /**
 326  * ether_addr_equal_64bits - Compare two Ethernet addresses
 327  * @addr1: Pointer to an array of 8 bytes
 328  * @addr2: Pointer to an other array of 8 bytes
 329  *
 330  * Compare two Ethernet addresses, returns true if equal, false otherwise.
 331  *
 332  * The function doesn't need any conditional branches and possibly uses
 333  * word memory accesses on CPU allowing cheap unaligned memory reads.
 334  * arrays = { byte1, byte2, byte3, byte4, byte5, byte6, pad1, pad2 }
 335  *
 336  * Please note that alignment of addr1 & addr2 are only guaranteed to be 16 bits.
 337  */
 338
 339 static inline bool ether_addr_equal_64bits(const u8 addr1[6+2],
 340                                            const u8 addr2[6+2])
 341 {
 342 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
 343         u64 fold = (*(const u64 *)addr1) ^ (*(const u64 *)addr2);
 344
 345 #ifdef __BIG_ENDIAN
 346         return (fold >> 16) == 0;
 347 #else
 348         return (fold << 16) == 0;
 349 #endif
 350 #else
 351         return ether_addr_equal(addr1, addr2);
 352 #endif
 353 }
 354
 355 /**
 356  * ether_addr_equal_unaligned - Compare two not u16 aligned Ethernet addresses
 357  * @addr1: Pointer to a six-byte array containing the Ethernet address
 358  * @addr2: Pointer other six-byte array containing the Ethernet address
 359  *
 360  * Compare two Ethernet addresses, returns true if equal
 361  *
 362  * Please note: Use only when any Ethernet address may not be u16 aligned.
 363  */
 364 static inline bool ether_addr_equal_unaligned(const u8 *addr1, const u8 *addr2)
 365 {
 366 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
 367         return ether_addr_equal(addr1, addr2);
 368 #else
 369         return memcmp(addr1, addr2, ETH_ALEN) == 0;
 370 #endif
 371 }
 372
 373 /**
 374  * is_etherdev_addr - Tell if given Ethernet address belongs to the device.
 375  * @dev: Pointer to a device structure
 376  * @addr: Pointer to a six-byte array containing the Ethernet address
 377  *
 378  * Compare passed address with all addresses of the device. Return true if the
 379  * address if one of the device addresses.
 380  *
 381  * Note that this function calls ether_addr_equal_64bits() so take care of
 382  * the right padding.
 383  */
 384 static inline bool is_etherdev_addr(const struct net_device *dev,
 385                                     const u8 addr[6 + 2])
 386 {
 387         struct netdev_hw_addr *ha;
 388         bool res = false;
 389
 390         rcu_read_lock();
 391         for_each_dev_addr(dev, ha) {
 392                 res = ether_addr_equal_64bits(addr, ha->addr);
 393                 if (res)
 394                         break;
 395         }
 396         rcu_read_unlock();
 397         return res;
 398 }
 399 #endif  /* __KERNEL__ */
 400
 401 /**
 402  * compare_ether_header - Compare two Ethernet headers
 403  * @a: Pointer to Ethernet header
 404  * @b: Pointer to Ethernet header
 405  *
 406  * Compare two Ethernet headers, returns 0 if equal.
 407  * This assumes that the network header (i.e., IP header) is 4-byte
 408  * aligned OR the platform can handle unaligned access.  This is the
 409  * case for all packets coming into netif_receive_skb or similar
 410  * entry points.
 411  */
 412
 413 static inline unsigned long compare_ether_header(const void *a, const void *b)
 414 {
 415 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
 416         unsigned long fold;
 417
 418         /*
 419          * We want to compare 14 bytes:
 420          *  [a0 ... a13] ^ [b0 ... b13]
 421          * Use two long XOR, ORed together, with an overlap of two bytes.
 422          *  [a0  a1  a2  a3  a4  a5  a6  a7 ] ^ [b0  b1  b2  b3  b4  b5  b6  b7 ] |
 423          *  [a6  a7  a8  a9  a10 a11 a12 a13] ^ [b6  b7  b8  b9  b10 b11 b12 b13]
 424          * This means the [a6 a7] ^ [b6 b7] part is done two times.
 425         */
 426         fold = *(unsigned long *)a ^ *(unsigned long *)b;
 427         fold |= *(unsigned long *)(a + 6) ^ *(unsigned long *)(b + 6);
 428         return fold;
 429 #else
 430         u32 *a32 = (u32 *)((u8 *)a + 2);
 431         u32 *b32 = (u32 *)((u8 *)b + 2);
 432
 433         return (*(u16 *)a ^ *(u16 *)b) | (a32[0] ^ b32[0]) |
 434                (a32[1] ^ b32[1]) | (a32[2] ^ b32[2]);
 435 #endif
 436 }
 437
 438 /**
 439  * eth_skb_pad - Pad buffer to mininum number of octets for Ethernet frame
 440  * @skb: Buffer to pad
 441  *
 442  * An Ethernet frame should have a minimum size of 60 bytes.  This function
 443  * takes short frames and pads them with zeros up to the 60 byte limit.
 444  */
 445 static inline int eth_skb_pad(struct sk_buff *skb)
 446 {
 447         return skb_put_padto(skb, ETH_ZLEN);
 448 }
 449
 450 #endif  /* _LINUX_ETHERDEVICE_H */