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