drivers/net/ethernet/intel/igc/igc.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /* Copyright (c)  2018 Intel Corporation */
   3
   4 #ifndef _IGC_H_
   5 #define _IGC_H_
   6
   7 #include <linux/kobject.h>
   8 #include <linux/pci.h>
   9 #include <linux/netdevice.h>
  10 #include <linux/vmalloc.h>
  11 #include <linux/ethtool.h>
  12 #include <linux/sctp.h>
  13 #include <linux/ptp_clock_kernel.h>
  14 #include <linux/timecounter.h>
  15 #include <linux/net_tstamp.h>
  16 #include <linux/bitfield.h>
  17
  18 #include "igc_hw.h"
  19
  20 void igc_ethtool_set_ops(struct net_device *);
  21
  22 /* Transmit and receive queues */
  23 #define IGC_MAX_RX_QUEUES               4
  24 #define IGC_MAX_TX_QUEUES               4
  25
  26 #define MAX_Q_VECTORS                   8
  27 #define MAX_STD_JUMBO_FRAME_SIZE        9216
  28
  29 #define MAX_ETYPE_FILTER                8
  30 #define IGC_RETA_SIZE                   128
  31
  32 /* SDP support */
  33 #define IGC_N_EXTTS     2
  34 #define IGC_N_PEROUT    2
  35 #define IGC_N_SDP       4
  36
  37 #define MAX_FLEX_FILTER                 32
  38
  39 enum igc_mac_filter_type {
  40         IGC_MAC_FILTER_TYPE_DST = 0,
  41         IGC_MAC_FILTER_TYPE_SRC
  42 };
  43
  44 struct igc_tx_queue_stats {
  45         u64 packets;
  46         u64 bytes;
  47         u64 restart_queue;
  48         u64 restart_queue2;
  49 };
  50
  51 struct igc_rx_queue_stats {
  52         u64 packets;
  53         u64 bytes;
  54         u64 drops;
  55         u64 csum_err;
  56         u64 alloc_failed;
  57 };
  58
  59 struct igc_rx_packet_stats {
  60         u64 ipv4_packets;      /* IPv4 headers processed */
  61         u64 ipv4e_packets;     /* IPv4E headers with extensions processed */
  62         u64 ipv6_packets;      /* IPv6 headers processed */
  63         u64 ipv6e_packets;     /* IPv6E headers with extensions processed */
  64         u64 tcp_packets;       /* TCP headers processed */
  65         u64 udp_packets;       /* UDP headers processed */
  66         u64 sctp_packets;      /* SCTP headers processed */
  67         u64 nfs_packets;       /* NFS headers processe */
  68         u64 other_packets;
  69 };
  70
  71 struct igc_ring_container {
  72         struct igc_ring *ring;          /* pointer to linked list of rings */
  73         unsigned int total_bytes;       /* total bytes processed this int */
  74         unsigned int total_packets;     /* total packets processed this int */
  75         u16 work_limit;                 /* total work allowed per interrupt */
  76         u8 count;                       /* total number of rings in vector */
  77         u8 itr;                         /* current ITR setting for ring */
  78 };
  79
  80 struct igc_ring {
  81         struct igc_q_vector *q_vector;  /* backlink to q_vector */
  82         struct net_device *netdev;      /* back pointer to net_device */
  83         struct device *dev;             /* device for dma mapping */
  84         union {                         /* array of buffer info structs */
  85                 struct igc_tx_buffer *tx_buffer_info;
  86                 struct igc_rx_buffer *rx_buffer_info;
  87         };
  88         void *desc;                     /* descriptor ring memory */
  89         unsigned long flags;            /* ring specific flags */
  90         void __iomem *tail;             /* pointer to ring tail register */
  91         dma_addr_t dma;                 /* phys address of the ring */
  92         unsigned int size;              /* length of desc. ring in bytes */
  93
  94         u16 count;                      /* number of desc. in the ring */
  95         u8 queue_index;                 /* logical index of the ring*/
  96         u8 reg_idx;                     /* physical index of the ring */
  97         bool launchtime_enable;         /* true if LaunchTime is enabled */
  98         ktime_t last_tx_cycle;          /* end of the cycle with a launchtime transmission */
  99         ktime_t last_ff_cycle;          /* Last cycle with an active first flag */
 100
 101         u32 start_time;
 102         u32 end_time;
 103         u32 max_sdu;
 104
 105         /* CBS parameters */
 106         bool cbs_enable;                /* indicates if CBS is enabled */
 107         s32 idleslope;                  /* idleSlope in kbps */
 108         s32 sendslope;                  /* sendSlope in kbps */
 109         s32 hicredit;                   /* hiCredit in bytes */
 110         s32 locredit;                   /* loCredit in bytes */
 111
 112         /* everything past this point are written often */
 113         u16 next_to_clean;
 114         u16 next_to_use;
 115         u16 next_to_alloc;
 116
 117         union {
 118                 /* TX */
 119                 struct {
 120                         struct igc_tx_queue_stats tx_stats;
 121                         struct u64_stats_sync tx_syncp;
 122                         struct u64_stats_sync tx_syncp2;
 123                 };
 124                 /* RX */
 125                 struct {
 126                         struct igc_rx_queue_stats rx_stats;
 127                         struct igc_rx_packet_stats pkt_stats;
 128                         struct u64_stats_sync rx_syncp;
 129                         struct sk_buff *skb;
 130                 };
 131         };
 132
 133         struct xdp_rxq_info xdp_rxq;
 134         struct xsk_buff_pool *xsk_pool;
 135 } ____cacheline_internodealigned_in_smp;
 136
 137 /* Board specific private data structure */
 138 struct igc_adapter {
 139         struct net_device *netdev;
 140
 141         struct ethtool_eee eee;
 142         u16 eee_advert;
 143
 144         unsigned long state;
 145         unsigned int flags;
 146         unsigned int num_q_vectors;
 147
 148         struct msix_entry *msix_entries;
 149
 150         /* TX */
 151         u16 tx_work_limit;
 152         u32 tx_timeout_count;
 153         int num_tx_queues;
 154         struct igc_ring *tx_ring[IGC_MAX_TX_QUEUES];
 155
 156         /* RX */
 157         int num_rx_queues;
 158         struct igc_ring *rx_ring[IGC_MAX_RX_QUEUES];
 159
 160         struct timer_list watchdog_timer;
 161         struct timer_list dma_err_timer;
 162         struct timer_list phy_info_timer;
 163
 164         u32 wol;
 165         u32 en_mng_pt;
 166         u16 link_speed;
 167         u16 link_duplex;
 168
 169         u8 port_num;
 170
 171         u8 __iomem *io_addr;
 172         /* Interrupt Throttle Rate */
 173         u32 rx_itr_setting;
 174         u32 tx_itr_setting;
 175
 176         struct work_struct reset_task;
 177         struct work_struct watchdog_task;
 178         struct work_struct dma_err_task;
 179         bool fc_autoneg;
 180
 181         u8 tx_timeout_factor;
 182
 183         int msg_enable;
 184         u32 max_frame_size;
 185         u32 min_frame_size;
 186
 187         int tc_setup_type;
 188         ktime_t base_time;
 189         ktime_t cycle_time;
 190         bool qbv_enable;
 191         u32 qbv_config_change_errors;
 192
 193         /* OS defined structs */
 194         struct pci_dev *pdev;
 195         /* lock for statistics */
 196         spinlock_t stats64_lock;
 197         struct rtnl_link_stats64 stats64;
 198
 199         /* structs defined in igc_hw.h */
 200         struct igc_hw hw;
 201         struct igc_hw_stats stats;
 202
 203         struct igc_q_vector *q_vector[MAX_Q_VECTORS];
 204         u32 eims_enable_mask;
 205         u32 eims_other;
 206
 207         u16 tx_ring_count;
 208         u16 rx_ring_count;
 209
 210         u32 tx_hwtstamp_timeouts;
 211         u32 tx_hwtstamp_skipped;
 212         u32 rx_hwtstamp_cleared;
 213
 214         u32 rss_queues;
 215         u32 rss_indir_tbl_init;
 216
 217         /* Any access to elements in nfc_rule_list is protected by the
 218          * nfc_rule_lock.
 219          */
 220         struct mutex nfc_rule_lock;
 221         struct list_head nfc_rule_list;
 222         unsigned int nfc_rule_count;
 223
 224         u8 rss_indir_tbl[IGC_RETA_SIZE];
 225
 226         unsigned long link_check_timeout;
 227         struct igc_info ei;
 228
 229         u32 test_icr;
 230
 231         struct ptp_clock *ptp_clock;
 232         struct ptp_clock_info ptp_caps;
 233         /* Access to ptp_tx_skb and ptp_tx_start are protected by the
 234          * ptp_tx_lock.
 235          */
 236         spinlock_t ptp_tx_lock;
 237         struct sk_buff *ptp_tx_skb;
 238         struct hwtstamp_config tstamp_config;
 239         unsigned long ptp_tx_start;
 240         unsigned int ptp_flags;
 241         /* System time value lock */
 242         spinlock_t tmreg_lock;
 243         struct cyclecounter cc;
 244         struct timecounter tc;
 245         struct timespec64 prev_ptp_time; /* Pre-reset PTP clock */
 246         ktime_t ptp_reset_start; /* Reset time in clock mono */
 247         struct system_time_snapshot snapshot;
 248
 249         char fw_version[32];
 250
 251         struct bpf_prog *xdp_prog;
 252
 253         bool pps_sys_wrap_on;
 254
 255         struct ptp_pin_desc sdp_config[IGC_N_SDP];
 256         struct {
 257                 struct timespec64 start;
 258                 struct timespec64 period;
 259         } perout[IGC_N_PEROUT];
 260 };
 261
 262 void igc_up(struct igc_adapter *adapter);
 263 void igc_down(struct igc_adapter *adapter);
 264 int igc_open(struct net_device *netdev);
 265 int igc_close(struct net_device *netdev);
 266 int igc_setup_tx_resources(struct igc_ring *ring);
 267 int igc_setup_rx_resources(struct igc_ring *ring);
 268 void igc_free_tx_resources(struct igc_ring *ring);
 269 void igc_free_rx_resources(struct igc_ring *ring);
 270 unsigned int igc_get_max_rss_queues(struct igc_adapter *adapter);
 271 void igc_set_flag_queue_pairs(struct igc_adapter *adapter,
 272                               const u32 max_rss_queues);
 273 int igc_reinit_queues(struct igc_adapter *adapter);
 274 void igc_write_rss_indir_tbl(struct igc_adapter *adapter);
 275 bool igc_has_link(struct igc_adapter *adapter);
 276 void igc_reset(struct igc_adapter *adapter);
 277 void igc_update_stats(struct igc_adapter *adapter);
 278 void igc_disable_rx_ring(struct igc_ring *ring);
 279 void igc_enable_rx_ring(struct igc_ring *ring);
 280 void igc_disable_tx_ring(struct igc_ring *ring);
 281 void igc_enable_tx_ring(struct igc_ring *ring);
 282 int igc_xsk_wakeup(struct net_device *dev, u32 queue_id, u32 flags);
 283
 284 /* igc_dump declarations */
 285 void igc_rings_dump(struct igc_adapter *adapter);
 286 void igc_regs_dump(struct igc_adapter *adapter);
 287
 288 extern char igc_driver_name[];
 289
 290 #define IGC_REGS_LEN                    740
 291
 292 /* flags controlling PTP/1588 function */
 293 #define IGC_PTP_ENABLED         BIT(0)
 294
 295 /* Flags definitions */
 296 #define IGC_FLAG_HAS_MSI                BIT(0)
 297 #define IGC_FLAG_QUEUE_PAIRS            BIT(3)
 298 #define IGC_FLAG_DMAC                   BIT(4)
 299 #define IGC_FLAG_PTP                    BIT(8)
 300 #define IGC_FLAG_WOL_SUPPORTED          BIT(8)
 301 #define IGC_FLAG_NEED_LINK_UPDATE       BIT(9)
 302 #define IGC_FLAG_HAS_MSIX               BIT(13)
 303 #define IGC_FLAG_EEE                    BIT(14)
 304 #define IGC_FLAG_VLAN_PROMISC           BIT(15)
 305 #define IGC_FLAG_RX_LEGACY              BIT(16)
 306 #define IGC_FLAG_TSN_QBV_ENABLED        BIT(17)
 307 #define IGC_FLAG_TSN_QAV_ENABLED        BIT(18)
 308
 309 #define IGC_FLAG_TSN_ANY_ENABLED \
 310         (IGC_FLAG_TSN_QBV_ENABLED | IGC_FLAG_TSN_QAV_ENABLED)
 311
 312 #define IGC_FLAG_RSS_FIELD_IPV4_UDP     BIT(6)
 313 #define IGC_FLAG_RSS_FIELD_IPV6_UDP     BIT(7)
 314
 315 #define IGC_MRQC_ENABLE_RSS_MQ          0x00000002
 316 #define IGC_MRQC_RSS_FIELD_IPV4_UDP     0x00400000
 317 #define IGC_MRQC_RSS_FIELD_IPV6_UDP     0x00800000
 318
 319 /* RX-desc Write-Back format RSS Type's */
 320 enum igc_rss_type_num {
 321         IGC_RSS_TYPE_NO_HASH            = 0,
 322         IGC_RSS_TYPE_HASH_TCP_IPV4      = 1,
 323         IGC_RSS_TYPE_HASH_IPV4          = 2,
 324         IGC_RSS_TYPE_HASH_TCP_IPV6      = 3,
 325         IGC_RSS_TYPE_HASH_IPV6_EX       = 4,
 326         IGC_RSS_TYPE_HASH_IPV6          = 5,
 327         IGC_RSS_TYPE_HASH_TCP_IPV6_EX   = 6,
 328         IGC_RSS_TYPE_HASH_UDP_IPV4      = 7,
 329         IGC_RSS_TYPE_HASH_UDP_IPV6      = 8,
 330         IGC_RSS_TYPE_HASH_UDP_IPV6_EX   = 9,
 331         IGC_RSS_TYPE_MAX                = 10,
 332 };
 333 #define IGC_RSS_TYPE_MAX_TABLE          16
 334 #define IGC_RSS_TYPE_MASK               GENMASK(3,0) /* 4-bits (3:0) = mask 0x0F */
 335
 336 /* igc_rss_type - Rx descriptor RSS type field */
 337 static inline u32 igc_rss_type(const union igc_adv_rx_desc *rx_desc)
 338 {
 339         /* RSS Type 4-bits (3:0) number: 0-9 (above 9 is reserved)
 340          * Accessing the same bits via u16 (wb.lower.lo_dword.hs_rss.pkt_info)
 341          * is slightly slower than via u32 (wb.lower.lo_dword.data)
 342          */
 343         return le32_get_bits(rx_desc->wb.lower.lo_dword.data, IGC_RSS_TYPE_MASK);
 344 }
 345
 346 /* Interrupt defines */
 347 #define IGC_START_ITR                   648 /* ~6000 ints/sec */
 348 #define IGC_4K_ITR                      980
 349 #define IGC_20K_ITR                     196
 350 #define IGC_70K_ITR                     56
 351
 352 #define IGC_DEFAULT_ITR         3 /* dynamic */
 353 #define IGC_MAX_ITR_USECS       10000
 354 #define IGC_MIN_ITR_USECS       10
 355 #define NON_Q_VECTORS           1
 356 #define MAX_MSIX_ENTRIES        10
 357
 358 /* TX/RX descriptor defines */
 359 #define IGC_DEFAULT_TXD         256
 360 #define IGC_DEFAULT_TX_WORK     128
 361 #define IGC_MIN_TXD             80
 362 #define IGC_MAX_TXD             4096
 363
 364 #define IGC_DEFAULT_RXD         256
 365 #define IGC_MIN_RXD             80
 366 #define IGC_MAX_RXD             4096
 367
 368 /* Supported Rx Buffer Sizes */
 369 #define IGC_RXBUFFER_256                256
 370 #define IGC_RXBUFFER_2048               2048
 371 #define IGC_RXBUFFER_3072               3072
 372
 373 #define AUTO_ALL_MODES          0
 374 #define IGC_RX_HDR_LEN                  IGC_RXBUFFER_256
 375
 376 /* Transmit and receive latency (for PTP timestamps) */
 377 #define IGC_I225_TX_LATENCY_10          240
 378 #define IGC_I225_TX_LATENCY_100         58
 379 #define IGC_I225_TX_LATENCY_1000        80
 380 #define IGC_I225_TX_LATENCY_2500        1325
 381 #define IGC_I225_RX_LATENCY_10          6450
 382 #define IGC_I225_RX_LATENCY_100         185
 383 #define IGC_I225_RX_LATENCY_1000        300
 384 #define IGC_I225_RX_LATENCY_2500        1485
 385
 386 /* RX and TX descriptor control thresholds.
 387  * PTHRESH - MAC will consider prefetch if it has fewer than this number of
 388  *           descriptors available in its onboard memory.
 389  *           Setting this to 0 disables RX descriptor prefetch.
 390  * HTHRESH - MAC will only prefetch if there are at least this many descriptors
 391  *           available in host memory.
 392  *           If PTHRESH is 0, this should also be 0.
 393  * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
 394  *           descriptors until either it has this many to write back, or the
 395  *           ITR timer expires.
 396  */
 397 #define IGC_RX_PTHRESH                  8
 398 #define IGC_RX_HTHRESH                  8
 399 #define IGC_TX_PTHRESH                  8
 400 #define IGC_TX_HTHRESH                  1
 401 #define IGC_RX_WTHRESH                  4
 402 #define IGC_TX_WTHRESH                  16
 403
 404 #define IGC_RX_DMA_ATTR \
 405         (DMA_ATTR_SKIP_CPU_SYNC | DMA_ATTR_WEAK_ORDERING)
 406
 407 #define IGC_TS_HDR_LEN                  16
 408
 409 #define IGC_SKB_PAD                     (NET_SKB_PAD + NET_IP_ALIGN)
 410
 411 #if (PAGE_SIZE < 8192)
 412 #define IGC_MAX_FRAME_BUILD_SKB \
 413         (SKB_WITH_OVERHEAD(IGC_RXBUFFER_2048) - IGC_SKB_PAD - IGC_TS_HDR_LEN)
 414 #else
 415 #define IGC_MAX_FRAME_BUILD_SKB (IGC_RXBUFFER_2048 - IGC_TS_HDR_LEN)
 416 #endif
 417
 418 /* How many Rx Buffers do we bundle into one write to the hardware ? */
 419 #define IGC_RX_BUFFER_WRITE     16 /* Must be power of 2 */
 420
 421 /* VLAN info */
 422 #define IGC_TX_FLAGS_VLAN_MASK  0xffff0000
 423 #define IGC_TX_FLAGS_VLAN_SHIFT 16
 424
 425 /* igc_test_staterr - tests bits within Rx descriptor status and error fields */
 426 static inline __le32 igc_test_staterr(union igc_adv_rx_desc *rx_desc,
 427                                       const u32 stat_err_bits)
 428 {
 429         return rx_desc->wb.upper.status_error & cpu_to_le32(stat_err_bits);
 430 }
 431
 432 enum igc_state_t {
 433         __IGC_TESTING,
 434         __IGC_RESETTING,
 435         __IGC_DOWN,
 436 };
 437
 438 enum igc_tx_flags {
 439         /* cmd_type flags */
 440         IGC_TX_FLAGS_VLAN       = 0x01,
 441         IGC_TX_FLAGS_TSO        = 0x02,
 442         IGC_TX_FLAGS_TSTAMP     = 0x04,
 443
 444         /* olinfo flags */
 445         IGC_TX_FLAGS_IPV4       = 0x10,
 446         IGC_TX_FLAGS_CSUM       = 0x20,
 447 };
 448
 449 enum igc_boards {
 450         board_base,
 451 };
 452
 453 /* The largest size we can write to the descriptor is 65535.  In order to
 454  * maintain a power of two alignment we have to limit ourselves to 32K.
 455  */
 456 #define IGC_MAX_TXD_PWR         15
 457 #define IGC_MAX_DATA_PER_TXD    BIT(IGC_MAX_TXD_PWR)
 458
 459 /* Tx Descriptors needed, worst case */
 460 #define TXD_USE_COUNT(S)        DIV_ROUND_UP((S), IGC_MAX_DATA_PER_TXD)
 461 #define DESC_NEEDED     (MAX_SKB_FRAGS + 4)
 462
 463 enum igc_tx_buffer_type {
 464         IGC_TX_BUFFER_TYPE_SKB,
 465         IGC_TX_BUFFER_TYPE_XDP,
 466         IGC_TX_BUFFER_TYPE_XSK,
 467 };
 468
 469 /* wrapper around a pointer to a socket buffer,
 470  * so a DMA handle can be stored along with the buffer
 471  */
 472 struct igc_tx_buffer {
 473         union igc_adv_tx_desc *next_to_watch;
 474         unsigned long time_stamp;
 475         enum igc_tx_buffer_type type;
 476         union {
 477                 struct sk_buff *skb;
 478                 struct xdp_frame *xdpf;
 479         };
 480         unsigned int bytecount;
 481         u16 gso_segs;
 482         __be16 protocol;
 483
 484         DEFINE_DMA_UNMAP_ADDR(dma);
 485         DEFINE_DMA_UNMAP_LEN(len);
 486         u32 tx_flags;
 487 };
 488
 489 struct igc_rx_buffer {
 490         union {
 491                 struct {
 492                         dma_addr_t dma;
 493                         struct page *page;
 494 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
 495                         __u32 page_offset;
 496 #else
 497                         __u16 page_offset;
 498 #endif
 499                         __u16 pagecnt_bias;
 500                 };
 501                 struct xdp_buff *xdp;
 502         };
 503 };
 504
 505 /* context wrapper around xdp_buff to provide access to descriptor metadata */
 506 struct igc_xdp_buff {
 507         struct xdp_buff xdp;
 508         union igc_adv_rx_desc *rx_desc;
 509         ktime_t rx_ts; /* data indication bit IGC_RXDADV_STAT_TSIP */
 510 };
 511
 512 struct igc_q_vector {
 513         struct igc_adapter *adapter;    /* backlink */
 514         void __iomem *itr_register;
 515         u32 eims_value;                 /* EIMS mask value */
 516
 517         u16 itr_val;
 518         u8 set_itr;
 519
 520         struct igc_ring_container rx, tx;
 521
 522         struct napi_struct napi;
 523
 524         struct rcu_head rcu;    /* to avoid race with update stats on free */
 525         char name[IFNAMSIZ + 9];
 526         struct net_device poll_dev;
 527
 528         /* for dynamic allocation of rings associated with this q_vector */
 529         struct igc_ring ring[] ____cacheline_internodealigned_in_smp;
 530 };
 531
 532 enum igc_filter_match_flags {
 533         IGC_FILTER_FLAG_ETHER_TYPE =    BIT(0),
 534         IGC_FILTER_FLAG_VLAN_TCI   =    BIT(1),
 535         IGC_FILTER_FLAG_SRC_MAC_ADDR =  BIT(2),
 536         IGC_FILTER_FLAG_DST_MAC_ADDR =  BIT(3),
 537         IGC_FILTER_FLAG_USER_DATA =     BIT(4),
 538         IGC_FILTER_FLAG_VLAN_ETYPE =    BIT(5),
 539 };
 540
 541 struct igc_nfc_filter {
 542         u8 match_flags;
 543         u16 etype;
 544         __be16 vlan_etype;
 545         u16 vlan_tci;
 546         u8 src_addr[ETH_ALEN];
 547         u8 dst_addr[ETH_ALEN];
 548         u8 user_data[8];
 549         u8 user_mask[8];
 550         u8 flex_index;
 551         u8 rx_queue;
 552         u8 prio;
 553         u8 immediate_irq;
 554         u8 drop;
 555 };
 556
 557 struct igc_nfc_rule {
 558         struct list_head list;
 559         struct igc_nfc_filter filter;
 560         u32 location;
 561         u16 action;
 562         bool flex;
 563 };
 564
 565 /* IGC supports a total of 32 NFC rules: 16 MAC address based, 8 VLAN priority
 566  * based, 8 ethertype based and 32 Flex filter based rules.
 567  */
 568 #define IGC_MAX_RXNFC_RULES             64
 569
 570 struct igc_flex_filter {
 571         u8 index;
 572         u8 data[128];
 573         u8 mask[16];
 574         u8 length;
 575         u8 rx_queue;
 576         u8 prio;
 577         u8 immediate_irq;
 578         u8 drop;
 579 };
 580
 581 /* igc_desc_unused - calculate if we have unused descriptors */
 582 static inline u16 igc_desc_unused(const struct igc_ring *ring)
 583 {
 584         u16 ntc = ring->next_to_clean;
 585         u16 ntu = ring->next_to_use;
 586
 587         return ((ntc > ntu) ? 0 : ring->count) + ntc - ntu - 1;
 588 }
 589
 590 static inline s32 igc_get_phy_info(struct igc_hw *hw)
 591 {
 592         if (hw->phy.ops.get_phy_info)
 593                 return hw->phy.ops.get_phy_info(hw);
 594
 595         return 0;
 596 }
 597
 598 static inline s32 igc_reset_phy(struct igc_hw *hw)
 599 {
 600         if (hw->phy.ops.reset)
 601                 return hw->phy.ops.reset(hw);
 602
 603         return 0;
 604 }
 605
 606 static inline struct netdev_queue *txring_txq(const struct igc_ring *tx_ring)
 607 {
 608         return netdev_get_tx_queue(tx_ring->netdev, tx_ring->queue_index);
 609 }
 610
 611 enum igc_ring_flags_t {
 612         IGC_RING_FLAG_RX_3K_BUFFER,
 613         IGC_RING_FLAG_RX_BUILD_SKB_ENABLED,
 614         IGC_RING_FLAG_RX_SCTP_CSUM,
 615         IGC_RING_FLAG_RX_LB_VLAN_BSWAP,
 616         IGC_RING_FLAG_TX_CTX_IDX,
 617         IGC_RING_FLAG_TX_DETECT_HANG,
 618         IGC_RING_FLAG_AF_XDP_ZC,
 619         IGC_RING_FLAG_TX_HWTSTAMP,
 620 };
 621
 622 #define ring_uses_large_buffer(ring) \
 623         test_bit(IGC_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
 624 #define set_ring_uses_large_buffer(ring) \
 625         set_bit(IGC_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
 626 #define clear_ring_uses_large_buffer(ring) \
 627         clear_bit(IGC_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
 628
 629 #define ring_uses_build_skb(ring) \
 630         test_bit(IGC_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
 631
 632 static inline unsigned int igc_rx_bufsz(struct igc_ring *ring)
 633 {
 634 #if (PAGE_SIZE < 8192)
 635         if (ring_uses_large_buffer(ring))
 636                 return IGC_RXBUFFER_3072;
 637
 638         if (ring_uses_build_skb(ring))
 639                 return IGC_MAX_FRAME_BUILD_SKB + IGC_TS_HDR_LEN;
 640 #endif
 641         return IGC_RXBUFFER_2048;
 642 }
 643
 644 static inline unsigned int igc_rx_pg_order(struct igc_ring *ring)
 645 {
 646 #if (PAGE_SIZE < 8192)
 647         if (ring_uses_large_buffer(ring))
 648                 return 1;
 649 #endif
 650         return 0;
 651 }
 652
 653 static inline s32 igc_read_phy_reg(struct igc_hw *hw, u32 offset, u16 *data)
 654 {
 655         if (hw->phy.ops.read_reg)
 656                 return hw->phy.ops.read_reg(hw, offset, data);
 657
 658         return -EOPNOTSUPP;
 659 }
 660
 661 void igc_reinit_locked(struct igc_adapter *);
 662 struct igc_nfc_rule *igc_get_nfc_rule(struct igc_adapter *adapter,
 663                                       u32 location);
 664 int igc_add_nfc_rule(struct igc_adapter *adapter, struct igc_nfc_rule *rule);
 665 void igc_del_nfc_rule(struct igc_adapter *adapter, struct igc_nfc_rule *rule);
 666
 667 void igc_ptp_init(struct igc_adapter *adapter);
 668 void igc_ptp_reset(struct igc_adapter *adapter);
 669 void igc_ptp_suspend(struct igc_adapter *adapter);
 670 void igc_ptp_stop(struct igc_adapter *adapter);
 671 ktime_t igc_ptp_rx_pktstamp(struct igc_adapter *adapter, __le32 *buf);
 672 int igc_ptp_set_ts_config(struct net_device *netdev, struct ifreq *ifr);
 673 int igc_ptp_get_ts_config(struct net_device *netdev, struct ifreq *ifr);
 674 void igc_ptp_tx_hang(struct igc_adapter *adapter);
 675 void igc_ptp_read(struct igc_adapter *adapter, struct timespec64 *ts);
 676 void igc_ptp_tx_tstamp_event(struct igc_adapter *adapter);
 677
 678 #define igc_rx_pg_size(_ring) (PAGE_SIZE << igc_rx_pg_order(_ring))
 679
 680 #define IGC_TXD_DCMD    (IGC_ADVTXD_DCMD_EOP | IGC_ADVTXD_DCMD_RS)
 681
 682 #define IGC_RX_DESC(R, i)       \
 683         (&(((union igc_adv_rx_desc *)((R)->desc))[i]))
 684 #define IGC_TX_DESC(R, i)       \
 685         (&(((union igc_adv_tx_desc *)((R)->desc))[i]))
 686 #define IGC_TX_CTXTDESC(R, i)   \
 687         (&(((struct igc_adv_tx_context_desc *)((R)->desc))[i]))
 688
 689 #endif /* _IGC_H_ */