1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright (c) 2018 Intel Corporation */
7 #include <linux/kobject.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>
19 void igc_ethtool_set_ops(struct net_device *);
21 /* Transmit and receive queues */
22 #define IGC_MAX_RX_QUEUES 4
23 #define IGC_MAX_TX_QUEUES 4
25 #define MAX_Q_VECTORS 8
26 #define MAX_STD_JUMBO_FRAME_SIZE 9216
28 #define MAX_ETYPE_FILTER 8
29 #define IGC_RETA_SIZE 128
33 #define IGC_N_PEROUT 2
36 #define MAX_FLEX_FILTER 32
38 enum igc_mac_filter_type {
39 IGC_MAC_FILTER_TYPE_DST = 0,
40 IGC_MAC_FILTER_TYPE_SRC
43 struct igc_tx_queue_stats {
50 struct igc_rx_queue_stats {
58 struct igc_rx_packet_stats {
59 u64 ipv4_packets; /* IPv4 headers processed */
60 u64 ipv4e_packets; /* IPv4E headers with extensions processed */
61 u64 ipv6_packets; /* IPv6 headers processed */
62 u64 ipv6e_packets; /* IPv6E headers with extensions processed */
63 u64 tcp_packets; /* TCP headers processed */
64 u64 udp_packets; /* UDP headers processed */
65 u64 sctp_packets; /* SCTP headers processed */
66 u64 nfs_packets; /* NFS headers processe */
70 struct igc_ring_container {
71 struct igc_ring *ring; /* pointer to linked list of rings */
72 unsigned int total_bytes; /* total bytes processed this int */
73 unsigned int total_packets; /* total packets processed this int */
74 u16 work_limit; /* total work allowed per interrupt */
75 u8 count; /* total number of rings in vector */
76 u8 itr; /* current ITR setting for ring */
80 struct igc_q_vector *q_vector; /* backlink to q_vector */
81 struct net_device *netdev; /* back pointer to net_device */
82 struct device *dev; /* device for dma mapping */
83 union { /* array of buffer info structs */
84 struct igc_tx_buffer *tx_buffer_info;
85 struct igc_rx_buffer *rx_buffer_info;
87 void *desc; /* descriptor ring memory */
88 unsigned long flags; /* ring specific flags */
89 void __iomem *tail; /* pointer to ring tail register */
90 dma_addr_t dma; /* phys address of the ring */
91 unsigned int size; /* length of desc. ring in bytes */
93 u16 count; /* number of desc. in the ring */
94 u8 queue_index; /* logical index of the ring*/
95 u8 reg_idx; /* physical index of the ring */
96 bool launchtime_enable; /* true if LaunchTime is enabled */
102 bool cbs_enable; /* indicates if CBS is enabled */
103 s32 idleslope; /* idleSlope in kbps */
104 s32 sendslope; /* sendSlope in kbps */
105 s32 hicredit; /* hiCredit in bytes */
106 s32 locredit; /* loCredit in bytes */
108 /* everything past this point are written often */
116 struct igc_tx_queue_stats tx_stats;
117 struct u64_stats_sync tx_syncp;
118 struct u64_stats_sync tx_syncp2;
122 struct igc_rx_queue_stats rx_stats;
123 struct igc_rx_packet_stats pkt_stats;
124 struct u64_stats_sync rx_syncp;
129 struct xdp_rxq_info xdp_rxq;
130 struct xsk_buff_pool *xsk_pool;
131 } ____cacheline_internodealigned_in_smp;
133 /* Board specific private data structure */
135 struct net_device *netdev;
137 struct ethtool_eee eee;
142 unsigned int num_q_vectors;
144 struct msix_entry *msix_entries;
148 u32 tx_timeout_count;
150 struct igc_ring *tx_ring[IGC_MAX_TX_QUEUES];
154 struct igc_ring *rx_ring[IGC_MAX_RX_QUEUES];
156 struct timer_list watchdog_timer;
157 struct timer_list dma_err_timer;
158 struct timer_list phy_info_timer;
168 /* Interrupt Throttle Rate */
172 struct work_struct reset_task;
173 struct work_struct watchdog_task;
174 struct work_struct dma_err_task;
177 u8 tx_timeout_factor;
186 /* OS defined structs */
187 struct pci_dev *pdev;
188 /* lock for statistics */
189 spinlock_t stats64_lock;
190 struct rtnl_link_stats64 stats64;
192 /* structs defined in igc_hw.h */
194 struct igc_hw_stats stats;
196 struct igc_q_vector *q_vector[MAX_Q_VECTORS];
197 u32 eims_enable_mask;
203 u32 tx_hwtstamp_timeouts;
204 u32 tx_hwtstamp_skipped;
205 u32 rx_hwtstamp_cleared;
208 u32 rss_indir_tbl_init;
210 /* Any access to elements in nfc_rule_list is protected by the
213 struct mutex nfc_rule_lock;
214 struct list_head nfc_rule_list;
215 unsigned int nfc_rule_count;
217 u8 rss_indir_tbl[IGC_RETA_SIZE];
219 unsigned long link_check_timeout;
224 struct ptp_clock *ptp_clock;
225 struct ptp_clock_info ptp_caps;
226 struct work_struct ptp_tx_work;
227 struct sk_buff *ptp_tx_skb;
228 struct hwtstamp_config tstamp_config;
229 unsigned long ptp_tx_start;
230 unsigned int ptp_flags;
231 /* System time value lock */
232 spinlock_t tmreg_lock;
233 struct cyclecounter cc;
234 struct timecounter tc;
235 struct timespec64 prev_ptp_time; /* Pre-reset PTP clock */
236 ktime_t ptp_reset_start; /* Reset time in clock mono */
237 struct system_time_snapshot snapshot;
241 struct bpf_prog *xdp_prog;
243 bool pps_sys_wrap_on;
245 struct ptp_pin_desc sdp_config[IGC_N_SDP];
247 struct timespec64 start;
248 struct timespec64 period;
249 } perout[IGC_N_PEROUT];
252 void igc_up(struct igc_adapter *adapter);
253 void igc_down(struct igc_adapter *adapter);
254 int igc_open(struct net_device *netdev);
255 int igc_close(struct net_device *netdev);
256 int igc_setup_tx_resources(struct igc_ring *ring);
257 int igc_setup_rx_resources(struct igc_ring *ring);
258 void igc_free_tx_resources(struct igc_ring *ring);
259 void igc_free_rx_resources(struct igc_ring *ring);
260 unsigned int igc_get_max_rss_queues(struct igc_adapter *adapter);
261 void igc_set_flag_queue_pairs(struct igc_adapter *adapter,
262 const u32 max_rss_queues);
263 int igc_reinit_queues(struct igc_adapter *adapter);
264 void igc_write_rss_indir_tbl(struct igc_adapter *adapter);
265 bool igc_has_link(struct igc_adapter *adapter);
266 void igc_reset(struct igc_adapter *adapter);
267 void igc_update_stats(struct igc_adapter *adapter);
268 void igc_disable_rx_ring(struct igc_ring *ring);
269 void igc_enable_rx_ring(struct igc_ring *ring);
270 void igc_disable_tx_ring(struct igc_ring *ring);
271 void igc_enable_tx_ring(struct igc_ring *ring);
272 int igc_xsk_wakeup(struct net_device *dev, u32 queue_id, u32 flags);
274 /* igc_dump declarations */
275 void igc_rings_dump(struct igc_adapter *adapter);
276 void igc_regs_dump(struct igc_adapter *adapter);
278 extern char igc_driver_name[];
280 #define IGC_REGS_LEN 740
282 /* flags controlling PTP/1588 function */
283 #define IGC_PTP_ENABLED BIT(0)
285 /* Flags definitions */
286 #define IGC_FLAG_HAS_MSI BIT(0)
287 #define IGC_FLAG_QUEUE_PAIRS BIT(3)
288 #define IGC_FLAG_DMAC BIT(4)
289 #define IGC_FLAG_PTP BIT(8)
290 #define IGC_FLAG_WOL_SUPPORTED BIT(8)
291 #define IGC_FLAG_NEED_LINK_UPDATE BIT(9)
292 #define IGC_FLAG_MEDIA_RESET BIT(10)
293 #define IGC_FLAG_MAS_ENABLE BIT(12)
294 #define IGC_FLAG_HAS_MSIX BIT(13)
295 #define IGC_FLAG_EEE BIT(14)
296 #define IGC_FLAG_VLAN_PROMISC BIT(15)
297 #define IGC_FLAG_RX_LEGACY BIT(16)
298 #define IGC_FLAG_TSN_QBV_ENABLED BIT(17)
299 #define IGC_FLAG_TSN_QAV_ENABLED BIT(18)
301 #define IGC_FLAG_TSN_ANY_ENABLED \
302 (IGC_FLAG_TSN_QBV_ENABLED | IGC_FLAG_TSN_QAV_ENABLED)
304 #define IGC_FLAG_RSS_FIELD_IPV4_UDP BIT(6)
305 #define IGC_FLAG_RSS_FIELD_IPV6_UDP BIT(7)
307 #define IGC_MRQC_ENABLE_RSS_MQ 0x00000002
308 #define IGC_MRQC_RSS_FIELD_IPV4_UDP 0x00400000
309 #define IGC_MRQC_RSS_FIELD_IPV6_UDP 0x00800000
311 /* Interrupt defines */
312 #define IGC_START_ITR 648 /* ~6000 ints/sec */
313 #define IGC_4K_ITR 980
314 #define IGC_20K_ITR 196
315 #define IGC_70K_ITR 56
317 #define IGC_DEFAULT_ITR 3 /* dynamic */
318 #define IGC_MAX_ITR_USECS 10000
319 #define IGC_MIN_ITR_USECS 10
320 #define NON_Q_VECTORS 1
321 #define MAX_MSIX_ENTRIES 10
323 /* TX/RX descriptor defines */
324 #define IGC_DEFAULT_TXD 256
325 #define IGC_DEFAULT_TX_WORK 128
326 #define IGC_MIN_TXD 80
327 #define IGC_MAX_TXD 4096
329 #define IGC_DEFAULT_RXD 256
330 #define IGC_MIN_RXD 80
331 #define IGC_MAX_RXD 4096
333 /* Supported Rx Buffer Sizes */
334 #define IGC_RXBUFFER_256 256
335 #define IGC_RXBUFFER_2048 2048
336 #define IGC_RXBUFFER_3072 3072
338 #define AUTO_ALL_MODES 0
339 #define IGC_RX_HDR_LEN IGC_RXBUFFER_256
341 /* Transmit and receive latency (for PTP timestamps) */
342 #define IGC_I225_TX_LATENCY_10 240
343 #define IGC_I225_TX_LATENCY_100 58
344 #define IGC_I225_TX_LATENCY_1000 80
345 #define IGC_I225_TX_LATENCY_2500 1325
346 #define IGC_I225_RX_LATENCY_10 6450
347 #define IGC_I225_RX_LATENCY_100 185
348 #define IGC_I225_RX_LATENCY_1000 300
349 #define IGC_I225_RX_LATENCY_2500 1485
351 /* RX and TX descriptor control thresholds.
352 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
353 * descriptors available in its onboard memory.
354 * Setting this to 0 disables RX descriptor prefetch.
355 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
356 * available in host memory.
357 * If PTHRESH is 0, this should also be 0.
358 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
359 * descriptors until either it has this many to write back, or the
362 #define IGC_RX_PTHRESH 8
363 #define IGC_RX_HTHRESH 8
364 #define IGC_TX_PTHRESH 8
365 #define IGC_TX_HTHRESH 1
366 #define IGC_RX_WTHRESH 4
367 #define IGC_TX_WTHRESH 16
369 #define IGC_RX_DMA_ATTR \
370 (DMA_ATTR_SKIP_CPU_SYNC | DMA_ATTR_WEAK_ORDERING)
372 #define IGC_TS_HDR_LEN 16
374 #define IGC_SKB_PAD (NET_SKB_PAD + NET_IP_ALIGN)
376 #if (PAGE_SIZE < 8192)
377 #define IGC_MAX_FRAME_BUILD_SKB \
378 (SKB_WITH_OVERHEAD(IGC_RXBUFFER_2048) - IGC_SKB_PAD - IGC_TS_HDR_LEN)
380 #define IGC_MAX_FRAME_BUILD_SKB (IGC_RXBUFFER_2048 - IGC_TS_HDR_LEN)
383 /* How many Rx Buffers do we bundle into one write to the hardware ? */
384 #define IGC_RX_BUFFER_WRITE 16 /* Must be power of 2 */
387 #define IGC_TX_FLAGS_VLAN_MASK 0xffff0000
388 #define IGC_TX_FLAGS_VLAN_SHIFT 16
390 /* igc_test_staterr - tests bits within Rx descriptor status and error fields */
391 static inline __le32 igc_test_staterr(union igc_adv_rx_desc *rx_desc,
392 const u32 stat_err_bits)
394 return rx_desc->wb.upper.status_error & cpu_to_le32(stat_err_bits);
401 __IGC_PTP_TX_IN_PROGRESS,
406 IGC_TX_FLAGS_VLAN = 0x01,
407 IGC_TX_FLAGS_TSO = 0x02,
408 IGC_TX_FLAGS_TSTAMP = 0x04,
411 IGC_TX_FLAGS_IPV4 = 0x10,
412 IGC_TX_FLAGS_CSUM = 0x20,
419 /* The largest size we can write to the descriptor is 65535. In order to
420 * maintain a power of two alignment we have to limit ourselves to 32K.
422 #define IGC_MAX_TXD_PWR 15
423 #define IGC_MAX_DATA_PER_TXD BIT(IGC_MAX_TXD_PWR)
425 /* Tx Descriptors needed, worst case */
426 #define TXD_USE_COUNT(S) DIV_ROUND_UP((S), IGC_MAX_DATA_PER_TXD)
427 #define DESC_NEEDED (MAX_SKB_FRAGS + 4)
429 enum igc_tx_buffer_type {
430 IGC_TX_BUFFER_TYPE_SKB,
431 IGC_TX_BUFFER_TYPE_XDP,
432 IGC_TX_BUFFER_TYPE_XSK,
435 /* wrapper around a pointer to a socket buffer,
436 * so a DMA handle can be stored along with the buffer
438 struct igc_tx_buffer {
439 union igc_adv_tx_desc *next_to_watch;
440 unsigned long time_stamp;
441 enum igc_tx_buffer_type type;
444 struct xdp_frame *xdpf;
446 unsigned int bytecount;
450 DEFINE_DMA_UNMAP_ADDR(dma);
451 DEFINE_DMA_UNMAP_LEN(len);
455 struct igc_rx_buffer {
460 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
467 struct xdp_buff *xdp;
471 struct igc_q_vector {
472 struct igc_adapter *adapter; /* backlink */
473 void __iomem *itr_register;
474 u32 eims_value; /* EIMS mask value */
479 struct igc_ring_container rx, tx;
481 struct napi_struct napi;
483 struct rcu_head rcu; /* to avoid race with update stats on free */
484 char name[IFNAMSIZ + 9];
485 struct net_device poll_dev;
487 /* for dynamic allocation of rings associated with this q_vector */
488 struct igc_ring ring[] ____cacheline_internodealigned_in_smp;
491 enum igc_filter_match_flags {
492 IGC_FILTER_FLAG_ETHER_TYPE = BIT(0),
493 IGC_FILTER_FLAG_VLAN_TCI = BIT(1),
494 IGC_FILTER_FLAG_SRC_MAC_ADDR = BIT(2),
495 IGC_FILTER_FLAG_DST_MAC_ADDR = BIT(3),
496 IGC_FILTER_FLAG_USER_DATA = BIT(4),
497 IGC_FILTER_FLAG_VLAN_ETYPE = BIT(5),
500 struct igc_nfc_filter {
505 u8 src_addr[ETH_ALEN];
506 u8 dst_addr[ETH_ALEN];
516 struct igc_nfc_rule {
517 struct list_head list;
518 struct igc_nfc_filter filter;
524 /* IGC supports a total of 32 NFC rules: 16 MAC address based, 8 VLAN priority
525 * based, 8 ethertype based and 32 Flex filter based rules.
527 #define IGC_MAX_RXNFC_RULES 64
529 struct igc_flex_filter {
540 /* igc_desc_unused - calculate if we have unused descriptors */
541 static inline u16 igc_desc_unused(const struct igc_ring *ring)
543 u16 ntc = ring->next_to_clean;
544 u16 ntu = ring->next_to_use;
546 return ((ntc > ntu) ? 0 : ring->count) + ntc - ntu - 1;
549 static inline s32 igc_get_phy_info(struct igc_hw *hw)
551 if (hw->phy.ops.get_phy_info)
552 return hw->phy.ops.get_phy_info(hw);
557 static inline s32 igc_reset_phy(struct igc_hw *hw)
559 if (hw->phy.ops.reset)
560 return hw->phy.ops.reset(hw);
565 static inline struct netdev_queue *txring_txq(const struct igc_ring *tx_ring)
567 return netdev_get_tx_queue(tx_ring->netdev, tx_ring->queue_index);
570 enum igc_ring_flags_t {
571 IGC_RING_FLAG_RX_3K_BUFFER,
572 IGC_RING_FLAG_RX_BUILD_SKB_ENABLED,
573 IGC_RING_FLAG_RX_SCTP_CSUM,
574 IGC_RING_FLAG_RX_LB_VLAN_BSWAP,
575 IGC_RING_FLAG_TX_CTX_IDX,
576 IGC_RING_FLAG_TX_DETECT_HANG,
577 IGC_RING_FLAG_AF_XDP_ZC,
580 #define ring_uses_large_buffer(ring) \
581 test_bit(IGC_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
582 #define set_ring_uses_large_buffer(ring) \
583 set_bit(IGC_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
584 #define clear_ring_uses_large_buffer(ring) \
585 clear_bit(IGC_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
587 #define ring_uses_build_skb(ring) \
588 test_bit(IGC_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
590 static inline unsigned int igc_rx_bufsz(struct igc_ring *ring)
592 #if (PAGE_SIZE < 8192)
593 if (ring_uses_large_buffer(ring))
594 return IGC_RXBUFFER_3072;
596 if (ring_uses_build_skb(ring))
597 return IGC_MAX_FRAME_BUILD_SKB + IGC_TS_HDR_LEN;
599 return IGC_RXBUFFER_2048;
602 static inline unsigned int igc_rx_pg_order(struct igc_ring *ring)
604 #if (PAGE_SIZE < 8192)
605 if (ring_uses_large_buffer(ring))
611 static inline s32 igc_read_phy_reg(struct igc_hw *hw, u32 offset, u16 *data)
613 if (hw->phy.ops.read_reg)
614 return hw->phy.ops.read_reg(hw, offset, data);
619 void igc_reinit_locked(struct igc_adapter *);
620 struct igc_nfc_rule *igc_get_nfc_rule(struct igc_adapter *adapter,
622 int igc_add_nfc_rule(struct igc_adapter *adapter, struct igc_nfc_rule *rule);
623 void igc_del_nfc_rule(struct igc_adapter *adapter, struct igc_nfc_rule *rule);
625 void igc_ptp_init(struct igc_adapter *adapter);
626 void igc_ptp_reset(struct igc_adapter *adapter);
627 void igc_ptp_suspend(struct igc_adapter *adapter);
628 void igc_ptp_stop(struct igc_adapter *adapter);
629 ktime_t igc_ptp_rx_pktstamp(struct igc_adapter *adapter, __le32 *buf);
630 int igc_ptp_set_ts_config(struct net_device *netdev, struct ifreq *ifr);
631 int igc_ptp_get_ts_config(struct net_device *netdev, struct ifreq *ifr);
632 void igc_ptp_tx_hang(struct igc_adapter *adapter);
633 void igc_ptp_read(struct igc_adapter *adapter, struct timespec64 *ts);
635 #define igc_rx_pg_size(_ring) (PAGE_SIZE << igc_rx_pg_order(_ring))
637 #define IGC_TXD_DCMD (IGC_ADVTXD_DCMD_EOP | IGC_ADVTXD_DCMD_RS)
639 #define IGC_RX_DESC(R, i) \
640 (&(((union igc_adv_rx_desc *)((R)->desc))[i]))
641 #define IGC_TX_DESC(R, i) \
642 (&(((union igc_adv_tx_desc *)((R)->desc))[i]))
643 #define IGC_TX_CTXTDESC(R, i) \
644 (&(((struct igc_adv_tx_context_desc *)((R)->desc))[i]))