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