include/linux/etherdevice.h

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