drivers/net/ethernet/intel/igb/igb.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright(c) 2007 - 2018 Intel Corporation. */
   3
   4 /* Linux PRO/1000 Ethernet Driver main header file */
   5
   6 #ifndef _IGB_H_
   7 #define _IGB_H_
   8
   9 #include "e1000_mac.h"
  10 #include "e1000_82575.h"
  11
  12 #include <linux/timecounter.h>
  13 #include <linux/net_tstamp.h>
  14 #include <linux/ptp_clock_kernel.h>
  15 #include <linux/bitops.h>
  16 #include <linux/if_vlan.h>
  17 #include <linux/i2c.h>
  18 #include <linux/i2c-algo-bit.h>
  19 #include <linux/pci.h>
  20 #include <linux/mdio.h>
  21 #include <linux/lockdep.h>
  22
  23 #include <net/xdp.h>
  24 #include <net/xdp_sock_drv.h>
  25
  26 struct igb_adapter;
  27
  28 #define E1000_PCS_CFG_IGN_SD    1
  29
  30 /* Interrupt defines */
  31 #define IGB_START_ITR           648 /* ~6000 ints/sec */
  32 #define IGB_4K_ITR              980
  33 #define IGB_20K_ITR             196
  34 #define IGB_70K_ITR             56
  35
  36 /* TX/RX descriptor defines */
  37 #define IGB_DEFAULT_TXD         256
  38 #define IGB_DEFAULT_TX_WORK     128
  39 #define IGB_MIN_TXD             64
  40 #define IGB_MAX_TXD             4096
  41
  42 #define IGB_DEFAULT_RXD         256
  43 #define IGB_MIN_RXD             64
  44 #define IGB_MAX_RXD             4096
  45
  46 #define IGB_DEFAULT_ITR         3 /* dynamic */
  47 #define IGB_MAX_ITR_USECS       10000
  48 #define IGB_MIN_ITR_USECS       10
  49 #define NON_Q_VECTORS           1
  50 #define MAX_Q_VECTORS           8
  51 #define MAX_MSIX_ENTRIES        10
  52
  53 /* Transmit and receive queues */
  54 #define IGB_MAX_RX_QUEUES       8
  55 #define IGB_MAX_RX_QUEUES_82575 4
  56 #define IGB_MAX_RX_QUEUES_I211  2
  57 #define IGB_MAX_TX_QUEUES       8
  58 #define IGB_MAX_VF_MC_ENTRIES   30
  59 #define IGB_MAX_VF_FUNCTIONS    8
  60 #define IGB_MAX_VFTA_ENTRIES    128
  61 #define IGB_82576_VF_DEV_ID     0x10CA
  62 #define IGB_I350_VF_DEV_ID      0x1520
  63
  64 /* NVM version defines */
  65 #define IGB_MAJOR_MASK          0xF000
  66 #define IGB_MINOR_MASK          0x0FF0
  67 #define IGB_BUILD_MASK          0x000F
  68 #define IGB_COMB_VER_MASK       0x00FF
  69 #define IGB_MAJOR_SHIFT         12
  70 #define IGB_MINOR_SHIFT         4
  71 #define IGB_COMB_VER_SHFT       8
  72 #define IGB_NVM_VER_INVALID     0xFFFF
  73 #define IGB_ETRACK_SHIFT        16
  74 #define NVM_ETRACK_WORD         0x0042
  75 #define NVM_COMB_VER_OFF        0x0083
  76 #define NVM_COMB_VER_PTR        0x003d
  77
  78 /* Transmit and receive latency (for PTP timestamps) */
  79 #define IGB_I210_TX_LATENCY_10          9542
  80 #define IGB_I210_TX_LATENCY_100         1024
  81 #define IGB_I210_TX_LATENCY_1000        178
  82 #define IGB_I210_RX_LATENCY_10          20662
  83 #define IGB_I210_RX_LATENCY_100         2213
  84 #define IGB_I210_RX_LATENCY_1000        448
  85
  86 /* XDP */
  87 #define IGB_XDP_PASS            0
  88 #define IGB_XDP_CONSUMED        BIT(0)
  89 #define IGB_XDP_TX              BIT(1)
  90 #define IGB_XDP_REDIR           BIT(2)
  91 #define IGB_XDP_EXIT            BIT(3)
  92
  93 struct vf_data_storage {
  94         unsigned char vf_mac_addresses[ETH_ALEN];
  95         u16 vf_mc_hashes[IGB_MAX_VF_MC_ENTRIES];
  96         u16 num_vf_mc_hashes;
  97         u32 flags;
  98         unsigned long last_nack;
  99         u16 pf_vlan; /* When set, guest VLAN config not allowed. */
 100         u16 pf_qos;
 101         u16 tx_rate;
 102         bool spoofchk_enabled;
 103         bool trusted;
 104 };
 105
 106 /* Number of unicast MAC filters reserved for the PF in the RAR registers */
 107 #define IGB_PF_MAC_FILTERS_RESERVED     3
 108
 109 struct vf_mac_filter {
 110         struct list_head l;
 111         int vf;
 112         bool free;
 113         u8 vf_mac[ETH_ALEN];
 114 };
 115
 116 #define IGB_VF_FLAG_CTS            0x00000001 /* VF is clear to send data */
 117 #define IGB_VF_FLAG_UNI_PROMISC    0x00000002 /* VF has unicast promisc */
 118 #define IGB_VF_FLAG_MULTI_PROMISC  0x00000004 /* VF has multicast promisc */
 119 #define IGB_VF_FLAG_PF_SET_MAC     0x00000008 /* PF has set MAC address */
 120
 121 /* RX descriptor control thresholds.
 122  * PTHRESH - MAC will consider prefetch if it has fewer than this number of
 123  *           descriptors available in its onboard memory.
 124  *           Setting this to 0 disables RX descriptor prefetch.
 125  * HTHRESH - MAC will only prefetch if there are at least this many descriptors
 126  *           available in host memory.
 127  *           If PTHRESH is 0, this should also be 0.
 128  * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
 129  *           descriptors until either it has this many to write back, or the
 130  *           ITR timer expires.
 131  */
 132 #define IGB_RX_PTHRESH  ((hw->mac.type == e1000_i354) ? 12 : 8)
 133 #define IGB_RX_HTHRESH  8
 134 #define IGB_TX_PTHRESH  ((hw->mac.type == e1000_i354) ? 20 : 8)
 135 #define IGB_TX_HTHRESH  1
 136 #define IGB_RX_WTHRESH  ((hw->mac.type == e1000_82576 && \
 137                           (adapter->flags & IGB_FLAG_HAS_MSIX)) ? 1 : 4)
 138 #define IGB_TX_WTHRESH  ((hw->mac.type == e1000_82576 && \
 139                           (adapter->flags & IGB_FLAG_HAS_MSIX)) ? 1 : 16)
 140
 141 /* this is the size past which hardware will drop packets when setting LPE=0 */
 142 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
 143
 144 #define IGB_ETH_PKT_HDR_PAD     (ETH_HLEN + ETH_FCS_LEN + (VLAN_HLEN * 2))
 145
 146 /* Supported Rx Buffer Sizes */
 147 #define IGB_RXBUFFER_256        256
 148 #define IGB_RXBUFFER_1536       1536
 149 #define IGB_RXBUFFER_2048       2048
 150 #define IGB_RXBUFFER_3072       3072
 151 #define IGB_RX_HDR_LEN          IGB_RXBUFFER_256
 152 #define IGB_TS_HDR_LEN          16
 153
 154 /* Attempt to maximize the headroom available for incoming frames.  We
 155  * use a 2K buffer for receives and need 1536/1534 to store the data for
 156  * the frame.  This leaves us with 512 bytes of room.  From that we need
 157  * to deduct the space needed for the shared info and the padding needed
 158  * to IP align the frame.
 159  *
 160  * Note: For cache line sizes 256 or larger this value is going to end
 161  *       up negative.  In these cases we should fall back to the 3K
 162  *       buffers.
 163  */
 164 #if (PAGE_SIZE < 8192)
 165 #define IGB_MAX_FRAME_BUILD_SKB (IGB_RXBUFFER_1536 - NET_IP_ALIGN)
 166 #define IGB_2K_TOO_SMALL_WITH_PADDING \
 167 ((NET_SKB_PAD + IGB_TS_HDR_LEN + IGB_RXBUFFER_1536) > SKB_WITH_OVERHEAD(IGB_RXBUFFER_2048))
 168
 169 static inline int igb_compute_pad(int rx_buf_len)
 170 {
 171         int page_size, pad_size;
 172
 173         page_size = ALIGN(rx_buf_len, PAGE_SIZE / 2);
 174         pad_size = SKB_WITH_OVERHEAD(page_size) - rx_buf_len;
 175
 176         return pad_size;
 177 }
 178
 179 static inline int igb_skb_pad(void)
 180 {
 181         int rx_buf_len;
 182
 183         /* If a 2K buffer cannot handle a standard Ethernet frame then
 184          * optimize padding for a 3K buffer instead of a 1.5K buffer.
 185          *
 186          * For a 3K buffer we need to add enough padding to allow for
 187          * tailroom due to NET_IP_ALIGN possibly shifting us out of
 188          * cache-line alignment.
 189          */
 190         if (IGB_2K_TOO_SMALL_WITH_PADDING)
 191                 rx_buf_len = IGB_RXBUFFER_3072 + SKB_DATA_ALIGN(NET_IP_ALIGN);
 192         else
 193                 rx_buf_len = IGB_RXBUFFER_1536;
 194
 195         /* if needed make room for NET_IP_ALIGN */
 196         rx_buf_len -= NET_IP_ALIGN;
 197
 198         return igb_compute_pad(rx_buf_len);
 199 }
 200
 201 #define IGB_SKB_PAD     igb_skb_pad()
 202 #else
 203 #define IGB_SKB_PAD     (NET_SKB_PAD + NET_IP_ALIGN)
 204 #endif
 205
 206 /* How many Rx Buffers do we bundle into one write to the hardware ? */
 207 #define IGB_RX_BUFFER_WRITE     16 /* Must be power of 2 */
 208
 209 #define IGB_RX_DMA_ATTR \
 210         (DMA_ATTR_SKIP_CPU_SYNC | DMA_ATTR_WEAK_ORDERING)
 211
 212 #define AUTO_ALL_MODES          0
 213 #define IGB_EEPROM_APME         0x0400
 214
 215 #ifndef IGB_MASTER_SLAVE
 216 /* Switch to override PHY master/slave setting */
 217 #define IGB_MASTER_SLAVE        e1000_ms_hw_default
 218 #endif
 219
 220 #define IGB_MNG_VLAN_NONE       -1
 221
 222 enum igb_tx_flags {
 223         /* cmd_type flags */
 224         IGB_TX_FLAGS_VLAN       = 0x01,
 225         IGB_TX_FLAGS_TSO        = 0x02,
 226         IGB_TX_FLAGS_TSTAMP     = 0x04,
 227
 228         /* olinfo flags */
 229         IGB_TX_FLAGS_IPV4       = 0x10,
 230         IGB_TX_FLAGS_CSUM       = 0x20,
 231 };
 232
 233 /* VLAN info */
 234 #define IGB_TX_FLAGS_VLAN_MASK  0xffff0000
 235 #define IGB_TX_FLAGS_VLAN_SHIFT 16
 236
 237 /* The largest size we can write to the descriptor is 65535.  In order to
 238  * maintain a power of two alignment we have to limit ourselves to 32K.
 239  */
 240 #define IGB_MAX_TXD_PWR 15
 241 #define IGB_MAX_DATA_PER_TXD    (1u << IGB_MAX_TXD_PWR)
 242
 243 /* Tx Descriptors needed, worst case */
 244 #define TXD_USE_COUNT(S) DIV_ROUND_UP((S), IGB_MAX_DATA_PER_TXD)
 245 #define DESC_NEEDED (MAX_SKB_FRAGS + 4)
 246
 247 /* EEPROM byte offsets */
 248 #define IGB_SFF_8472_SWAP               0x5C
 249 #define IGB_SFF_8472_COMP               0x5E
 250
 251 /* Bitmasks */
 252 #define IGB_SFF_ADDRESSING_MODE         0x4
 253 #define IGB_SFF_8472_UNSUP              0x00
 254
 255 /* TX resources are shared between XDP and netstack
 256  * and we need to tag the buffer type to distinguish them
 257  */
 258 enum igb_tx_buf_type {
 259         IGB_TYPE_SKB = 0,
 260         IGB_TYPE_XDP,
 261         IGB_TYPE_XSK
 262 };
 263
 264 /* wrapper around a pointer to a socket buffer,
 265  * so a DMA handle can be stored along with the buffer
 266  */
 267 struct igb_tx_buffer {
 268         union e1000_adv_tx_desc *next_to_watch;
 269         unsigned long time_stamp;
 270         enum igb_tx_buf_type type;
 271         union {
 272                 struct sk_buff *skb;
 273                 struct xdp_frame *xdpf;
 274         };
 275         unsigned int bytecount;
 276         u16 gso_segs;
 277         __be16 protocol;
 278
 279         DEFINE_DMA_UNMAP_ADDR(dma);
 280         DEFINE_DMA_UNMAP_LEN(len);
 281         u32 tx_flags;
 282 };
 283
 284 struct igb_rx_buffer {
 285         dma_addr_t dma;
 286         struct page *page;
 287 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
 288         __u32 page_offset;
 289 #else
 290         __u16 page_offset;
 291 #endif
 292         __u16 pagecnt_bias;
 293 };
 294
 295 struct igb_tx_queue_stats {
 296         u64 packets;
 297         u64 bytes;
 298         u64 restart_queue;
 299         u64 restart_queue2;
 300 };
 301
 302 struct igb_rx_queue_stats {
 303         u64 packets;
 304         u64 bytes;
 305         u64 drops;
 306         u64 csum_err;
 307         u64 alloc_failed;
 308 };
 309
 310 struct igb_ring_container {
 311         struct igb_ring *ring;          /* pointer to linked list of rings */
 312         unsigned int total_bytes;       /* total bytes processed this int */
 313         unsigned int total_packets;     /* total packets processed this int */
 314         u16 work_limit;                 /* total work allowed per interrupt */
 315         u8 count;                       /* total number of rings in vector */
 316         u8 itr;                         /* current ITR setting for ring */
 317 };
 318
 319 struct igb_ring {
 320         struct igb_q_vector *q_vector;  /* backlink to q_vector */
 321         struct net_device *netdev;      /* back pointer to net_device */
 322         struct bpf_prog *xdp_prog;
 323         struct device *dev;             /* device pointer for dma mapping */
 324         union {                         /* array of buffer info structs */
 325                 struct igb_tx_buffer *tx_buffer_info;
 326                 struct igb_rx_buffer *rx_buffer_info;
 327                 struct xdp_buff **rx_buffer_info_zc;
 328         };
 329         void *desc;                     /* descriptor ring memory */
 330         unsigned long flags;            /* ring specific flags */
 331         void __iomem *tail;             /* pointer to ring tail register */
 332         dma_addr_t dma;                 /* phys address of the ring */
 333         unsigned int  size;             /* length of desc. ring in bytes */
 334
 335         u16 count;                      /* number of desc. in the ring */
 336         u8 queue_index;                 /* logical index of the ring*/
 337         u8 reg_idx;                     /* physical index of the ring */
 338         bool launchtime_enable;         /* true if LaunchTime is enabled */
 339         bool cbs_enable;                /* indicates if CBS is enabled */
 340         s32 idleslope;                  /* idleSlope in kbps */
 341         s32 sendslope;                  /* sendSlope in kbps */
 342         s32 hicredit;                   /* hiCredit in bytes */
 343         s32 locredit;                   /* loCredit in bytes */
 344
 345         /* everything past this point are written often */
 346         u16 next_to_clean;
 347         u16 next_to_use;
 348         u16 next_to_alloc;
 349
 350         union {
 351                 /* TX */
 352                 struct {
 353                         struct igb_tx_queue_stats tx_stats;
 354                         struct u64_stats_sync tx_syncp;
 355                         struct u64_stats_sync tx_syncp2;
 356                 };
 357                 /* RX */
 358                 struct {
 359                         struct sk_buff *skb;
 360                         struct igb_rx_queue_stats rx_stats;
 361                         struct u64_stats_sync rx_syncp;
 362                 };
 363         };
 364         struct xdp_rxq_info xdp_rxq;
 365         struct xsk_buff_pool *xsk_pool;
 366 } ____cacheline_internodealigned_in_smp;
 367
 368 struct igb_q_vector {
 369         struct igb_adapter *adapter;    /* backlink */
 370         int cpu;                        /* CPU for DCA */
 371         u32 eims_value;                 /* EIMS mask value */
 372
 373         u16 itr_val;
 374         u8 set_itr;
 375         void __iomem *itr_register;
 376
 377         struct igb_ring_container rx, tx;
 378
 379         struct napi_struct napi;
 380         struct rcu_head rcu;    /* to avoid race with update stats on free */
 381         char name[IFNAMSIZ + 9];
 382
 383         /* for dynamic allocation of rings associated with this q_vector */
 384         struct igb_ring ring[] ____cacheline_internodealigned_in_smp;
 385 };
 386
 387 enum e1000_ring_flags_t {
 388         IGB_RING_FLAG_RX_3K_BUFFER,
 389         IGB_RING_FLAG_RX_BUILD_SKB_ENABLED,
 390         IGB_RING_FLAG_RX_SCTP_CSUM,
 391         IGB_RING_FLAG_RX_LB_VLAN_BSWAP,
 392         IGB_RING_FLAG_TX_CTX_IDX,
 393         IGB_RING_FLAG_TX_DETECT_HANG,
 394         IGB_RING_FLAG_TX_DISABLED
 395 };
 396
 397 #define ring_uses_large_buffer(ring) \
 398         test_bit(IGB_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
 399 #define set_ring_uses_large_buffer(ring) \
 400         set_bit(IGB_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
 401 #define clear_ring_uses_large_buffer(ring) \
 402         clear_bit(IGB_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
 403
 404 #define ring_uses_build_skb(ring) \
 405         test_bit(IGB_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
 406 #define set_ring_build_skb_enabled(ring) \
 407         set_bit(IGB_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
 408 #define clear_ring_build_skb_enabled(ring) \
 409         clear_bit(IGB_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
 410
 411 static inline unsigned int igb_rx_bufsz(struct igb_ring *ring)
 412 {
 413 #if (PAGE_SIZE < 8192)
 414         if (ring_uses_large_buffer(ring))
 415                 return IGB_RXBUFFER_3072;
 416
 417         if (ring_uses_build_skb(ring))
 418                 return IGB_MAX_FRAME_BUILD_SKB;
 419 #endif
 420         return IGB_RXBUFFER_2048;
 421 }
 422
 423 static inline unsigned int igb_rx_pg_order(struct igb_ring *ring)
 424 {
 425 #if (PAGE_SIZE < 8192)
 426         if (ring_uses_large_buffer(ring))
 427                 return 1;
 428 #endif
 429         return 0;
 430 }
 431
 432 #define igb_rx_pg_size(_ring) (PAGE_SIZE << igb_rx_pg_order(_ring))
 433
 434 #define IGB_TXD_DCMD (E1000_ADVTXD_DCMD_EOP | E1000_ADVTXD_DCMD_RS)
 435
 436 #define IGB_RX_DESC(R, i)       \
 437         (&(((union e1000_adv_rx_desc *)((R)->desc))[i]))
 438 #define IGB_TX_DESC(R, i)       \
 439         (&(((union e1000_adv_tx_desc *)((R)->desc))[i]))
 440 #define IGB_TX_CTXTDESC(R, i)   \
 441         (&(((struct e1000_adv_tx_context_desc *)((R)->desc))[i]))
 442
 443 /* igb_test_staterr - tests bits within Rx descriptor status and error fields */
 444 static inline __le32 igb_test_staterr(union e1000_adv_rx_desc *rx_desc,
 445                                       const u32 stat_err_bits)
 446 {
 447         return rx_desc->wb.upper.status_error & cpu_to_le32(stat_err_bits);
 448 }
 449
 450 /* igb_desc_unused - calculate if we have unused descriptors */
 451 static inline int igb_desc_unused(struct igb_ring *ring)
 452 {
 453         if (ring->next_to_clean > ring->next_to_use)
 454                 return ring->next_to_clean - ring->next_to_use - 1;
 455
 456         return ring->count + ring->next_to_clean - ring->next_to_use - 1;
 457 }
 458
 459 #ifdef CONFIG_IGB_HWMON
 460
 461 #define IGB_HWMON_TYPE_LOC      0
 462 #define IGB_HWMON_TYPE_TEMP     1
 463 #define IGB_HWMON_TYPE_CAUTION  2
 464 #define IGB_HWMON_TYPE_MAX      3
 465
 466 struct hwmon_attr {
 467         struct device_attribute dev_attr;
 468         struct e1000_hw *hw;
 469         struct e1000_thermal_diode_data *sensor;
 470         char name[12];
 471         };
 472
 473 struct hwmon_buff {
 474         struct attribute_group group;
 475         const struct attribute_group *groups[2];
 476         struct attribute *attrs[E1000_MAX_SENSORS * 4 + 1];
 477         struct hwmon_attr hwmon_list[E1000_MAX_SENSORS * 4];
 478         unsigned int n_hwmon;
 479         };
 480 #endif
 481
 482 /* The number of L2 ether-type filter registers, Index 3 is reserved
 483  * for PTP 1588 timestamp
 484  */
 485 #define MAX_ETYPE_FILTER        (4 - 1)
 486 /* ETQF filter list: one static filter per filter consumer. This is
 487  * to avoid filter collisions later. Add new filters here!!
 488  *
 489  * Current filters:             Filter 3
 490  */
 491 #define IGB_ETQF_FILTER_1588    3
 492
 493 #define IGB_N_EXTTS     2
 494 #define IGB_N_PEROUT    2
 495 #define IGB_N_SDP       4
 496 #define IGB_RETA_SIZE   128
 497
 498 enum igb_filter_match_flags {
 499         IGB_FILTER_FLAG_ETHER_TYPE = 0x1,
 500         IGB_FILTER_FLAG_VLAN_TCI   = 0x2,
 501         IGB_FILTER_FLAG_SRC_MAC_ADDR   = 0x4,
 502         IGB_FILTER_FLAG_DST_MAC_ADDR   = 0x8,
 503 };
 504
 505 #define IGB_MAX_RXNFC_FILTERS 16
 506
 507 /* RX network flow classification data structure */
 508 struct igb_nfc_input {
 509         /* Byte layout in order, all values with MSB first:
 510          * match_flags - 1 byte
 511          * etype - 2 bytes
 512          * vlan_tci - 2 bytes
 513          */
 514         u8 match_flags;
 515         __be16 etype;
 516         __be16 vlan_tci;
 517         u8 src_addr[ETH_ALEN];
 518         u8 dst_addr[ETH_ALEN];
 519 };
 520
 521 struct igb_nfc_filter {
 522         struct hlist_node nfc_node;
 523         struct igb_nfc_input filter;
 524         unsigned long cookie;
 525         u16 etype_reg_index;
 526         u16 sw_idx;
 527         u16 action;
 528 };
 529
 530 struct igb_mac_addr {
 531         u8 addr[ETH_ALEN];
 532         u8 queue;
 533         u8 state; /* bitmask */
 534 };
 535
 536 #define IGB_MAC_STATE_DEFAULT   0x1
 537 #define IGB_MAC_STATE_IN_USE    0x2
 538 #define IGB_MAC_STATE_SRC_ADDR  0x4
 539 #define IGB_MAC_STATE_QUEUE_STEERING 0x8
 540
 541 /* board specific private data structure */
 542 struct igb_adapter {
 543         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
 544
 545         struct net_device *netdev;
 546         struct bpf_prog *xdp_prog;
 547
 548         unsigned long state;
 549         unsigned int flags;
 550
 551         unsigned int num_q_vectors;
 552         struct msix_entry msix_entries[MAX_MSIX_ENTRIES];
 553
 554         /* Interrupt Throttle Rate */
 555         u32 rx_itr_setting;
 556         u32 tx_itr_setting;
 557         u16 tx_itr;
 558         u16 rx_itr;
 559
 560         /* TX */
 561         u16 tx_work_limit;
 562         u32 tx_timeout_count;
 563         int num_tx_queues;
 564         struct igb_ring *tx_ring[16];
 565
 566         /* RX */
 567         int num_rx_queues;
 568         struct igb_ring *rx_ring[16];
 569
 570         u32 max_frame_size;
 571         u32 min_frame_size;
 572
 573         struct timer_list watchdog_timer;
 574         struct timer_list phy_info_timer;
 575
 576         u16 mng_vlan_id;
 577         u32 bd_number;
 578         u32 wol;
 579         u32 en_mng_pt;
 580         u16 link_speed;
 581         u16 link_duplex;
 582
 583         u8 __iomem *io_addr; /* Mainly for iounmap use */
 584
 585         struct work_struct reset_task;
 586         struct work_struct watchdog_task;
 587         bool fc_autoneg;
 588         u8  tx_timeout_factor;
 589         struct timer_list blink_timer;
 590         unsigned long led_status;
 591
 592         /* OS defined structs */
 593         struct pci_dev *pdev;
 594
 595         spinlock_t stats64_lock;
 596         struct rtnl_link_stats64 stats64;
 597
 598         /* structs defined in e1000_hw.h */
 599         struct e1000_hw hw;
 600         struct e1000_hw_stats stats;
 601         struct e1000_phy_info phy_info;
 602
 603         u32 test_icr;
 604         struct igb_ring test_tx_ring;
 605         struct igb_ring test_rx_ring;
 606
 607         int msg_enable;
 608
 609         struct igb_q_vector *q_vector[MAX_Q_VECTORS];
 610         u32 eims_enable_mask;
 611         u32 eims_other;
 612
 613         /* to not mess up cache alignment, always add to the bottom */
 614         u16 tx_ring_count;
 615         u16 rx_ring_count;
 616         unsigned int vfs_allocated_count;
 617         struct vf_data_storage *vf_data;
 618         int vf_rate_link_speed;
 619         u32 rss_queues;
 620         u32 wvbr;
 621         u32 *shadow_vfta;
 622
 623         struct ptp_clock *ptp_clock;
 624         struct ptp_clock_info ptp_caps;
 625         struct delayed_work ptp_overflow_work;
 626         struct work_struct ptp_tx_work;
 627         struct sk_buff *ptp_tx_skb;
 628         struct hwtstamp_config tstamp_config;
 629         unsigned long ptp_tx_start;
 630         unsigned long last_rx_ptp_check;
 631         unsigned long last_rx_timestamp;
 632         unsigned int ptp_flags;
 633         spinlock_t tmreg_lock;
 634         struct cyclecounter cc;
 635         struct timecounter tc;
 636         u32 tx_hwtstamp_timeouts;
 637         u32 tx_hwtstamp_skipped;
 638         u32 rx_hwtstamp_cleared;
 639         bool pps_sys_wrap_on;
 640
 641         struct ptp_pin_desc sdp_config[IGB_N_SDP];
 642         struct {
 643                 struct timespec64 start;
 644                 struct timespec64 period;
 645         } perout[IGB_N_PEROUT];
 646
 647         char fw_version[48];
 648 #ifdef CONFIG_IGB_HWMON
 649         struct hwmon_buff *igb_hwmon_buff;
 650         bool ets;
 651 #endif
 652         struct i2c_algo_bit_data i2c_algo;
 653         struct i2c_adapter i2c_adap;
 654         struct i2c_client *i2c_client;
 655         u32 rss_indir_tbl_init;
 656         u8 rss_indir_tbl[IGB_RETA_SIZE];
 657
 658         unsigned long link_check_timeout;
 659         int copper_tries;
 660         struct e1000_info ei;
 661         u16 eee_advert;
 662
 663         /* RX network flow classification support */
 664         struct hlist_head nfc_filter_list;
 665         struct hlist_head cls_flower_list;
 666         unsigned int nfc_filter_count;
 667         /* lock for RX network flow classification filter */
 668         spinlock_t nfc_lock;
 669         bool etype_bitmap[MAX_ETYPE_FILTER];
 670
 671         struct igb_mac_addr *mac_table;
 672         struct vf_mac_filter vf_macs;
 673         struct vf_mac_filter *vf_mac_list;
 674         /* lock for VF resources */
 675         spinlock_t vfs_lock;
 676 };
 677
 678 /* flags controlling PTP/1588 function */
 679 #define IGB_PTP_ENABLED         BIT(0)
 680 #define IGB_PTP_OVERFLOW_CHECK  BIT(1)
 681
 682 #define IGB_FLAG_HAS_MSI                BIT(0)
 683 #define IGB_FLAG_DCA_ENABLED            BIT(1)
 684 #define IGB_FLAG_QUAD_PORT_A            BIT(2)
 685 #define IGB_FLAG_QUEUE_PAIRS            BIT(3)
 686 #define IGB_FLAG_DMAC                   BIT(4)
 687 #define IGB_FLAG_RSS_FIELD_IPV4_UDP     BIT(6)
 688 #define IGB_FLAG_RSS_FIELD_IPV6_UDP     BIT(7)
 689 #define IGB_FLAG_WOL_SUPPORTED          BIT(8)
 690 #define IGB_FLAG_NEED_LINK_UPDATE       BIT(9)
 691 #define IGB_FLAG_MEDIA_RESET            BIT(10)
 692 #define IGB_FLAG_MAS_CAPABLE            BIT(11)
 693 #define IGB_FLAG_MAS_ENABLE             BIT(12)
 694 #define IGB_FLAG_HAS_MSIX               BIT(13)
 695 #define IGB_FLAG_EEE                    BIT(14)
 696 #define IGB_FLAG_VLAN_PROMISC           BIT(15)
 697 #define IGB_FLAG_RX_LEGACY              BIT(16)
 698 #define IGB_FLAG_FQTSS                  BIT(17)
 699
 700 /* Media Auto Sense */
 701 #define IGB_MAS_ENABLE_0                0X0001
 702 #define IGB_MAS_ENABLE_1                0X0002
 703 #define IGB_MAS_ENABLE_2                0X0004
 704 #define IGB_MAS_ENABLE_3                0X0008
 705
 706 /* DMA Coalescing defines */
 707 #define IGB_MIN_TXPBSIZE        20408
 708 #define IGB_TX_BUF_4096         4096
 709 #define IGB_DMCTLX_DCFLUSH_DIS  0x80000000  /* Disable DMA Coal Flush */
 710
 711 #define IGB_82576_TSYNC_SHIFT   19
 712 enum e1000_state_t {
 713         __IGB_TESTING,
 714         __IGB_RESETTING,
 715         __IGB_DOWN,
 716         __IGB_PTP_TX_IN_PROGRESS,
 717 };
 718
 719 enum igb_boards {
 720         board_82575,
 721 };
 722
 723 extern char igb_driver_name[];
 724
 725 int igb_xmit_xdp_ring(struct igb_adapter *adapter,
 726                       struct igb_ring *ring,
 727                       struct xdp_frame *xdpf);
 728 int igb_open(struct net_device *netdev);
 729 int igb_close(struct net_device *netdev);
 730 int igb_up(struct igb_adapter *);
 731 void igb_down(struct igb_adapter *);
 732 void igb_reinit_locked(struct igb_adapter *);
 733 void igb_reset(struct igb_adapter *);
 734 int igb_reinit_queues(struct igb_adapter *);
 735 void igb_write_rss_indir_tbl(struct igb_adapter *);
 736 int igb_set_spd_dplx(struct igb_adapter *, u32, u8);
 737 int igb_setup_tx_resources(struct igb_ring *);
 738 int igb_setup_rx_resources(struct igb_ring *);
 739 void igb_free_tx_resources(struct igb_ring *);
 740 void igb_free_rx_resources(struct igb_ring *);
 741 void igb_clean_tx_ring(struct igb_ring *tx_ring);
 742 void igb_clean_rx_ring(struct igb_ring *rx_ring);
 743 void igb_configure_tx_ring(struct igb_adapter *, struct igb_ring *);
 744 void igb_configure_rx_ring(struct igb_adapter *, struct igb_ring *);
 745 void igb_finalize_xdp(struct igb_adapter *adapter, unsigned int status);
 746 void igb_update_rx_stats(struct igb_q_vector *q_vector, unsigned int packets,
 747                          unsigned int bytes);
 748 void igb_setup_tctl(struct igb_adapter *);
 749 void igb_setup_rctl(struct igb_adapter *);
 750 void igb_setup_srrctl(struct igb_adapter *, struct igb_ring *);
 751 netdev_tx_t igb_xmit_frame_ring(struct sk_buff *, struct igb_ring *);
 752 int igb_xdp_xmit_back(struct igb_adapter *adapter, struct xdp_buff *xdp);
 753 void igb_process_skb_fields(struct igb_ring *rx_ring,
 754                             union e1000_adv_rx_desc *rx_desc,
 755                             struct sk_buff *skb);
 756 void igb_alloc_rx_buffers(struct igb_ring *, u16);
 757 void igb_update_stats(struct igb_adapter *);
 758 bool igb_has_link(struct igb_adapter *adapter);
 759 void igb_set_ethtool_ops(struct net_device *);
 760 void igb_power_up_link(struct igb_adapter *);
 761 void igb_set_fw_version(struct igb_adapter *);
 762 void igb_ptp_init(struct igb_adapter *adapter);
 763 void igb_ptp_stop(struct igb_adapter *adapter);
 764 void igb_ptp_reset(struct igb_adapter *adapter);
 765 void igb_ptp_suspend(struct igb_adapter *adapter);
 766 void igb_ptp_rx_hang(struct igb_adapter *adapter);
 767 void igb_ptp_tx_hang(struct igb_adapter *adapter);
 768 void igb_ptp_rx_rgtstamp(struct igb_q_vector *q_vector, struct sk_buff *skb);
 769 int igb_ptp_rx_pktstamp(struct igb_q_vector *q_vector, void *va,
 770                         ktime_t *timestamp);
 771 int igb_ptp_set_ts_config(struct net_device *netdev, struct ifreq *ifr);
 772 int igb_ptp_get_ts_config(struct net_device *netdev, struct ifreq *ifr);
 773 void igb_set_flag_queue_pairs(struct igb_adapter *, const u32);
 774 unsigned int igb_get_max_rss_queues(struct igb_adapter *);
 775 #ifdef CONFIG_IGB_HWMON
 776 void igb_sysfs_exit(struct igb_adapter *adapter);
 777 int igb_sysfs_init(struct igb_adapter *adapter);
 778 #endif
 779 static inline s32 igb_reset_phy(struct e1000_hw *hw)
 780 {
 781         if (hw->phy.ops.reset)
 782                 return hw->phy.ops.reset(hw);
 783
 784         return 0;
 785 }
 786
 787 static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
 788 {
 789         if (hw->phy.ops.read_reg)
 790                 return hw->phy.ops.read_reg(hw, offset, data);
 791
 792         return 0;
 793 }
 794
 795 static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
 796 {
 797         if (hw->phy.ops.write_reg)
 798                 return hw->phy.ops.write_reg(hw, offset, data);
 799
 800         return 0;
 801 }
 802
 803 static inline s32 igb_get_phy_info(struct e1000_hw *hw)
 804 {
 805         if (hw->phy.ops.get_phy_info)
 806                 return hw->phy.ops.get_phy_info(hw);
 807
 808         return 0;
 809 }
 810
 811 static inline struct netdev_queue *txring_txq(const struct igb_ring *tx_ring)
 812 {
 813         return netdev_get_tx_queue(tx_ring->netdev, tx_ring->queue_index);
 814 }
 815
 816 /* This function assumes __netif_tx_lock is held by the caller. */
 817 static inline void igb_xdp_ring_update_tail(struct igb_ring *ring)
 818 {
 819         lockdep_assert_held(&txring_txq(ring)->_xmit_lock);
 820
 821         /* Force memory writes to complete before letting h/w know there
 822          * are new descriptors to fetch.
 823          */
 824         wmb();
 825         writel(ring->next_to_use, ring->tail);
 826 }
 827
 828 static inline struct igb_ring *igb_xdp_tx_queue_mapping(struct igb_adapter *adapter)
 829 {
 830         unsigned int r_idx = smp_processor_id();
 831
 832         if (r_idx >= adapter->num_tx_queues)
 833                 r_idx = r_idx % adapter->num_tx_queues;
 834
 835         return adapter->tx_ring[r_idx];
 836 }
 837
 838 static inline bool igb_xdp_is_enabled(struct igb_adapter *adapter)
 839 {
 840         return !!READ_ONCE(adapter->xdp_prog);
 841 }
 842
 843 int igb_add_filter(struct igb_adapter *adapter,
 844                    struct igb_nfc_filter *input);
 845 int igb_erase_filter(struct igb_adapter *adapter,
 846                      struct igb_nfc_filter *input);
 847
 848 int igb_add_mac_steering_filter(struct igb_adapter *adapter,
 849                                 const u8 *addr, u8 queue, u8 flags);
 850 int igb_del_mac_steering_filter(struct igb_adapter *adapter,
 851                                 const u8 *addr, u8 queue, u8 flags);
 852
 853 struct xsk_buff_pool *igb_xsk_pool(struct igb_adapter *adapter,
 854                                    struct igb_ring *ring);
 855 int igb_xsk_pool_setup(struct igb_adapter *adapter,
 856                        struct xsk_buff_pool *pool,
 857                        u16 qid);
 858 bool igb_alloc_rx_buffers_zc(struct igb_ring *rx_ring,
 859                              struct xsk_buff_pool *xsk_pool, u16 count);
 860 void igb_clean_rx_ring_zc(struct igb_ring *rx_ring);
 861 int igb_clean_rx_irq_zc(struct igb_q_vector *q_vector,
 862                         struct xsk_buff_pool *xsk_pool, const int budget);
 863 bool igb_xmit_zc(struct igb_ring *tx_ring, struct xsk_buff_pool *xsk_pool);
 864 int igb_xsk_wakeup(struct net_device *dev, u32 qid, u32 flags);
 865
 866 #endif /* _IGB_H_ */