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>
16 #include <linux/bitfield.h>
20 void igc_ethtool_set_ops(struct net_device *);
22 /* Transmit and receive queues */
23 #define IGC_MAX_RX_QUEUES 4
24 #define IGC_MAX_TX_QUEUES 4
26 #define MAX_Q_VECTORS 8
27 #define MAX_STD_JUMBO_FRAME_SIZE 9216
29 #define MAX_ETYPE_FILTER 8
30 #define IGC_RETA_SIZE 128
32 enum igc_mac_filter_type {
33 IGC_MAC_FILTER_TYPE_DST = 0,
34 IGC_MAC_FILTER_TYPE_SRC
37 struct igc_tx_queue_stats {
44 struct igc_rx_queue_stats {
52 struct igc_rx_packet_stats {
53 u64 ipv4_packets; /* IPv4 headers processed */
54 u64 ipv4e_packets; /* IPv4E headers with extensions processed */
55 u64 ipv6_packets; /* IPv6 headers processed */
56 u64 ipv6e_packets; /* IPv6E headers with extensions processed */
57 u64 tcp_packets; /* TCP headers processed */
58 u64 udp_packets; /* UDP headers processed */
59 u64 sctp_packets; /* SCTP headers processed */
60 u64 nfs_packets; /* NFS headers processe */
64 struct igc_ring_container {
65 struct igc_ring *ring; /* pointer to linked list of rings */
66 unsigned int total_bytes; /* total bytes processed this int */
67 unsigned int total_packets; /* total packets processed this int */
68 u16 work_limit; /* total work allowed per interrupt */
69 u8 count; /* total number of rings in vector */
70 u8 itr; /* current ITR setting for ring */
74 struct igc_q_vector *q_vector; /* backlink to q_vector */
75 struct net_device *netdev; /* back pointer to net_device */
76 struct device *dev; /* device for dma mapping */
77 union { /* array of buffer info structs */
78 struct igc_tx_buffer *tx_buffer_info;
79 struct igc_rx_buffer *rx_buffer_info;
81 void *desc; /* descriptor ring memory */
82 unsigned long flags; /* ring specific flags */
83 void __iomem *tail; /* pointer to ring tail register */
84 dma_addr_t dma; /* phys address of the ring */
85 unsigned int size; /* length of desc. ring in bytes */
87 u16 count; /* number of desc. in the ring */
88 u8 queue_index; /* logical index of the ring*/
89 u8 reg_idx; /* physical index of the ring */
90 bool launchtime_enable; /* true if LaunchTime is enabled */
91 ktime_t last_tx_cycle; /* end of the cycle with a launchtime transmission */
92 ktime_t last_ff_cycle; /* Last cycle with an active first flag */
97 /* everything past this point are written often */
105 struct igc_tx_queue_stats tx_stats;
106 struct u64_stats_sync tx_syncp;
107 struct u64_stats_sync tx_syncp2;
111 struct igc_rx_queue_stats rx_stats;
112 struct igc_rx_packet_stats pkt_stats;
113 struct u64_stats_sync rx_syncp;
117 } ____cacheline_internodealigned_in_smp;
119 /* Board specific private data structure */
121 struct net_device *netdev;
123 struct ethtool_eee eee;
128 unsigned int num_q_vectors;
130 struct msix_entry *msix_entries;
134 u32 tx_timeout_count;
136 struct igc_ring *tx_ring[IGC_MAX_TX_QUEUES];
140 struct igc_ring *rx_ring[IGC_MAX_RX_QUEUES];
142 struct timer_list watchdog_timer;
143 struct timer_list dma_err_timer;
144 struct timer_list phy_info_timer;
154 /* Interrupt Throttle Rate */
158 struct work_struct reset_task;
159 struct work_struct watchdog_task;
160 struct work_struct dma_err_task;
163 u8 tx_timeout_factor;
172 /* OS defined structs */
173 struct pci_dev *pdev;
174 /* lock for statistics */
175 spinlock_t stats64_lock;
176 struct rtnl_link_stats64 stats64;
178 /* structs defined in igc_hw.h */
180 struct igc_hw_stats stats;
182 struct igc_q_vector *q_vector[MAX_Q_VECTORS];
183 u32 eims_enable_mask;
189 u32 tx_hwtstamp_timeouts;
190 u32 tx_hwtstamp_skipped;
191 u32 rx_hwtstamp_cleared;
194 u32 rss_indir_tbl_init;
196 /* Any access to elements in nfc_rule_list is protected by the
199 struct mutex nfc_rule_lock;
200 struct list_head nfc_rule_list;
201 unsigned int nfc_rule_count;
203 u8 rss_indir_tbl[IGC_RETA_SIZE];
205 unsigned long link_check_timeout;
210 struct ptp_clock *ptp_clock;
211 struct ptp_clock_info ptp_caps;
212 struct work_struct ptp_tx_work;
213 /* Access to ptp_tx_skb and ptp_tx_start are protected by the
216 spinlock_t ptp_tx_lock;
217 struct sk_buff *ptp_tx_skb;
218 struct hwtstamp_config tstamp_config;
219 unsigned long ptp_tx_start;
220 unsigned int ptp_flags;
221 /* System time value lock */
222 spinlock_t tmreg_lock;
223 struct cyclecounter cc;
224 struct timecounter tc;
225 struct timespec64 prev_ptp_time; /* Pre-reset PTP clock */
226 ktime_t ptp_reset_start; /* Reset time in clock mono */
229 void igc_up(struct igc_adapter *adapter);
230 void igc_down(struct igc_adapter *adapter);
231 int igc_open(struct net_device *netdev);
232 int igc_close(struct net_device *netdev);
233 int igc_setup_tx_resources(struct igc_ring *ring);
234 int igc_setup_rx_resources(struct igc_ring *ring);
235 void igc_free_tx_resources(struct igc_ring *ring);
236 void igc_free_rx_resources(struct igc_ring *ring);
237 unsigned int igc_get_max_rss_queues(struct igc_adapter *adapter);
238 void igc_set_flag_queue_pairs(struct igc_adapter *adapter,
239 const u32 max_rss_queues);
240 int igc_reinit_queues(struct igc_adapter *adapter);
241 void igc_write_rss_indir_tbl(struct igc_adapter *adapter);
242 bool igc_has_link(struct igc_adapter *adapter);
243 void igc_reset(struct igc_adapter *adapter);
244 int igc_set_spd_dplx(struct igc_adapter *adapter, u32 spd, u8 dplx);
245 void igc_update_stats(struct igc_adapter *adapter);
247 /* igc_dump declarations */
248 void igc_rings_dump(struct igc_adapter *adapter);
249 void igc_regs_dump(struct igc_adapter *adapter);
251 extern char igc_driver_name[];
253 #define IGC_REGS_LEN 740
255 /* flags controlling PTP/1588 function */
256 #define IGC_PTP_ENABLED BIT(0)
258 /* Flags definitions */
259 #define IGC_FLAG_HAS_MSI BIT(0)
260 #define IGC_FLAG_QUEUE_PAIRS BIT(3)
261 #define IGC_FLAG_DMAC BIT(4)
262 #define IGC_FLAG_PTP BIT(8)
263 #define IGC_FLAG_WOL_SUPPORTED BIT(8)
264 #define IGC_FLAG_NEED_LINK_UPDATE BIT(9)
265 #define IGC_FLAG_MEDIA_RESET BIT(10)
266 #define IGC_FLAG_MAS_ENABLE BIT(12)
267 #define IGC_FLAG_HAS_MSIX BIT(13)
268 #define IGC_FLAG_EEE BIT(14)
269 #define IGC_FLAG_VLAN_PROMISC BIT(15)
270 #define IGC_FLAG_RX_LEGACY BIT(16)
271 #define IGC_FLAG_TSN_QBV_ENABLED BIT(17)
273 #define IGC_FLAG_RSS_FIELD_IPV4_UDP BIT(6)
274 #define IGC_FLAG_RSS_FIELD_IPV6_UDP BIT(7)
276 #define IGC_MRQC_ENABLE_RSS_MQ 0x00000002
277 #define IGC_MRQC_RSS_FIELD_IPV4_UDP 0x00400000
278 #define IGC_MRQC_RSS_FIELD_IPV6_UDP 0x00800000
280 /* RX-desc Write-Back format RSS Type's */
281 enum igc_rss_type_num {
282 IGC_RSS_TYPE_NO_HASH = 0,
283 IGC_RSS_TYPE_HASH_TCP_IPV4 = 1,
284 IGC_RSS_TYPE_HASH_IPV4 = 2,
285 IGC_RSS_TYPE_HASH_TCP_IPV6 = 3,
286 IGC_RSS_TYPE_HASH_IPV6_EX = 4,
287 IGC_RSS_TYPE_HASH_IPV6 = 5,
288 IGC_RSS_TYPE_HASH_TCP_IPV6_EX = 6,
289 IGC_RSS_TYPE_HASH_UDP_IPV4 = 7,
290 IGC_RSS_TYPE_HASH_UDP_IPV6 = 8,
291 IGC_RSS_TYPE_HASH_UDP_IPV6_EX = 9,
292 IGC_RSS_TYPE_MAX = 10,
294 #define IGC_RSS_TYPE_MAX_TABLE 16
295 #define IGC_RSS_TYPE_MASK GENMASK(3,0) /* 4-bits (3:0) = mask 0x0F */
297 /* igc_rss_type - Rx descriptor RSS type field */
298 static inline u32 igc_rss_type(const union igc_adv_rx_desc *rx_desc)
300 /* RSS Type 4-bits (3:0) number: 0-9 (above 9 is reserved)
301 * Accessing the same bits via u16 (wb.lower.lo_dword.hs_rss.pkt_info)
302 * is slightly slower than via u32 (wb.lower.lo_dword.data)
304 return le32_get_bits(rx_desc->wb.lower.lo_dword.data, IGC_RSS_TYPE_MASK);
307 /* Interrupt defines */
308 #define IGC_START_ITR 648 /* ~6000 ints/sec */
309 #define IGC_4K_ITR 980
310 #define IGC_20K_ITR 196
311 #define IGC_70K_ITR 56
313 #define IGC_DEFAULT_ITR 3 /* dynamic */
314 #define IGC_MAX_ITR_USECS 10000
315 #define IGC_MIN_ITR_USECS 10
316 #define NON_Q_VECTORS 1
317 #define MAX_MSIX_ENTRIES 10
319 /* TX/RX descriptor defines */
320 #define IGC_DEFAULT_TXD 256
321 #define IGC_DEFAULT_TX_WORK 128
322 #define IGC_MIN_TXD 64
323 #define IGC_MAX_TXD 4096
325 #define IGC_DEFAULT_RXD 256
326 #define IGC_MIN_RXD 64
327 #define IGC_MAX_RXD 4096
329 /* Supported Rx Buffer Sizes */
330 #define IGC_RXBUFFER_256 256
331 #define IGC_RXBUFFER_2048 2048
332 #define IGC_RXBUFFER_3072 3072
334 #define AUTO_ALL_MODES 0
335 #define IGC_RX_HDR_LEN IGC_RXBUFFER_256
337 /* Transmit and receive latency (for PTP timestamps) */
338 #define IGC_I225_TX_LATENCY_10 240
339 #define IGC_I225_TX_LATENCY_100 58
340 #define IGC_I225_TX_LATENCY_1000 80
341 #define IGC_I225_TX_LATENCY_2500 1325
342 #define IGC_I225_RX_LATENCY_10 6450
343 #define IGC_I225_RX_LATENCY_100 185
344 #define IGC_I225_RX_LATENCY_1000 300
345 #define IGC_I225_RX_LATENCY_2500 1485
347 /* RX and TX descriptor control thresholds.
348 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
349 * descriptors available in its onboard memory.
350 * Setting this to 0 disables RX descriptor prefetch.
351 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
352 * available in host memory.
353 * If PTHRESH is 0, this should also be 0.
354 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
355 * descriptors until either it has this many to write back, or the
358 #define IGC_RX_PTHRESH 8
359 #define IGC_RX_HTHRESH 8
360 #define IGC_TX_PTHRESH 8
361 #define IGC_TX_HTHRESH 1
362 #define IGC_RX_WTHRESH 4
363 #define IGC_TX_WTHRESH 16
365 #define IGC_RX_DMA_ATTR \
366 (DMA_ATTR_SKIP_CPU_SYNC | DMA_ATTR_WEAK_ORDERING)
368 #define IGC_TS_HDR_LEN 16
370 #define IGC_SKB_PAD (NET_SKB_PAD + NET_IP_ALIGN)
372 #if (PAGE_SIZE < 8192)
373 #define IGC_MAX_FRAME_BUILD_SKB \
374 (SKB_WITH_OVERHEAD(IGC_RXBUFFER_2048) - IGC_SKB_PAD - IGC_TS_HDR_LEN)
376 #define IGC_MAX_FRAME_BUILD_SKB (IGC_RXBUFFER_2048 - IGC_TS_HDR_LEN)
379 /* How many Rx Buffers do we bundle into one write to the hardware ? */
380 #define IGC_RX_BUFFER_WRITE 16 /* Must be power of 2 */
383 #define IGC_TX_FLAGS_VLAN_MASK 0xffff0000
385 /* igc_test_staterr - tests bits within Rx descriptor status and error fields */
386 static inline __le32 igc_test_staterr(union igc_adv_rx_desc *rx_desc,
387 const u32 stat_err_bits)
389 return rx_desc->wb.upper.status_error & cpu_to_le32(stat_err_bits);
400 IGC_TX_FLAGS_VLAN = 0x01,
401 IGC_TX_FLAGS_TSO = 0x02,
402 IGC_TX_FLAGS_TSTAMP = 0x04,
405 IGC_TX_FLAGS_IPV4 = 0x10,
406 IGC_TX_FLAGS_CSUM = 0x20,
413 /* The largest size we can write to the descriptor is 65535. In order to
414 * maintain a power of two alignment we have to limit ourselves to 32K.
416 #define IGC_MAX_TXD_PWR 15
417 #define IGC_MAX_DATA_PER_TXD BIT(IGC_MAX_TXD_PWR)
419 /* Tx Descriptors needed, worst case */
420 #define TXD_USE_COUNT(S) DIV_ROUND_UP((S), IGC_MAX_DATA_PER_TXD)
421 #define DESC_NEEDED (MAX_SKB_FRAGS + 4)
423 /* wrapper around a pointer to a socket buffer,
424 * so a DMA handle can be stored along with the buffer
426 struct igc_tx_buffer {
427 union igc_adv_tx_desc *next_to_watch;
428 unsigned long time_stamp;
430 unsigned int bytecount;
434 DEFINE_DMA_UNMAP_ADDR(dma);
435 DEFINE_DMA_UNMAP_LEN(len);
439 struct igc_rx_buffer {
442 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
450 struct igc_q_vector {
451 struct igc_adapter *adapter; /* backlink */
452 void __iomem *itr_register;
453 u32 eims_value; /* EIMS mask value */
458 struct igc_ring_container rx, tx;
460 struct napi_struct napi;
462 struct rcu_head rcu; /* to avoid race with update stats on free */
463 char name[IFNAMSIZ + 9];
464 struct net_device poll_dev;
466 /* for dynamic allocation of rings associated with this q_vector */
467 struct igc_ring ring[] ____cacheline_internodealigned_in_smp;
470 enum igc_filter_match_flags {
471 IGC_FILTER_FLAG_ETHER_TYPE = 0x1,
472 IGC_FILTER_FLAG_VLAN_TCI = 0x2,
473 IGC_FILTER_FLAG_SRC_MAC_ADDR = 0x4,
474 IGC_FILTER_FLAG_DST_MAC_ADDR = 0x8,
477 struct igc_nfc_filter {
481 u8 src_addr[ETH_ALEN];
482 u8 dst_addr[ETH_ALEN];
485 struct igc_nfc_rule {
486 struct list_head list;
487 struct igc_nfc_filter filter;
492 /* IGC supports a total of 32 NFC rules: 16 MAC address based,, 8 VLAN priority
493 * based, and 8 ethertype based.
495 #define IGC_MAX_RXNFC_RULES 32
497 /* igc_desc_unused - calculate if we have unused descriptors */
498 static inline u16 igc_desc_unused(const struct igc_ring *ring)
500 u16 ntc = ring->next_to_clean;
501 u16 ntu = ring->next_to_use;
503 return ((ntc > ntu) ? 0 : ring->count) + ntc - ntu - 1;
506 static inline s32 igc_get_phy_info(struct igc_hw *hw)
508 if (hw->phy.ops.get_phy_info)
509 return hw->phy.ops.get_phy_info(hw);
514 static inline s32 igc_reset_phy(struct igc_hw *hw)
516 if (hw->phy.ops.reset)
517 return hw->phy.ops.reset(hw);
522 static inline struct netdev_queue *txring_txq(const struct igc_ring *tx_ring)
524 return netdev_get_tx_queue(tx_ring->netdev, tx_ring->queue_index);
527 enum igc_ring_flags_t {
528 IGC_RING_FLAG_RX_3K_BUFFER,
529 IGC_RING_FLAG_RX_BUILD_SKB_ENABLED,
530 IGC_RING_FLAG_RX_SCTP_CSUM,
531 IGC_RING_FLAG_RX_LB_VLAN_BSWAP,
532 IGC_RING_FLAG_TX_CTX_IDX,
533 IGC_RING_FLAG_TX_DETECT_HANG
536 #define ring_uses_large_buffer(ring) \
537 test_bit(IGC_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
539 #define ring_uses_build_skb(ring) \
540 test_bit(IGC_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
542 static inline unsigned int igc_rx_bufsz(struct igc_ring *ring)
544 #if (PAGE_SIZE < 8192)
545 if (ring_uses_large_buffer(ring))
546 return IGC_RXBUFFER_3072;
548 if (ring_uses_build_skb(ring))
549 return IGC_MAX_FRAME_BUILD_SKB + IGC_TS_HDR_LEN;
551 return IGC_RXBUFFER_2048;
554 static inline unsigned int igc_rx_pg_order(struct igc_ring *ring)
556 #if (PAGE_SIZE < 8192)
557 if (ring_uses_large_buffer(ring))
563 static inline s32 igc_read_phy_reg(struct igc_hw *hw, u32 offset, u16 *data)
565 if (hw->phy.ops.read_reg)
566 return hw->phy.ops.read_reg(hw, offset, data);
571 void igc_reinit_locked(struct igc_adapter *);
572 struct igc_nfc_rule *igc_get_nfc_rule(struct igc_adapter *adapter,
574 int igc_add_nfc_rule(struct igc_adapter *adapter, struct igc_nfc_rule *rule);
575 void igc_del_nfc_rule(struct igc_adapter *adapter, struct igc_nfc_rule *rule);
577 void igc_ptp_init(struct igc_adapter *adapter);
578 void igc_ptp_reset(struct igc_adapter *adapter);
579 void igc_ptp_suspend(struct igc_adapter *adapter);
580 void igc_ptp_stop(struct igc_adapter *adapter);
581 void igc_ptp_rx_pktstamp(struct igc_q_vector *q_vector, __le32 *va,
582 struct sk_buff *skb);
583 int igc_ptp_set_ts_config(struct net_device *netdev, struct ifreq *ifr);
584 int igc_ptp_get_ts_config(struct net_device *netdev, struct ifreq *ifr);
585 void igc_ptp_tx_hang(struct igc_adapter *adapter);
586 void igc_ptp_read(struct igc_adapter *adapter, struct timespec64 *ts);
588 #define igc_rx_pg_size(_ring) (PAGE_SIZE << igc_rx_pg_order(_ring))
590 #define IGC_TXD_DCMD (IGC_ADVTXD_DCMD_EOP | IGC_ADVTXD_DCMD_RS)
592 #define IGC_RX_DESC(R, i) \
593 (&(((union igc_adv_rx_desc *)((R)->desc))[i]))
594 #define IGC_TX_DESC(R, i) \
595 (&(((union igc_adv_tx_desc *)((R)->desc))[i]))
596 #define IGC_TX_CTXTDESC(R, i) \
597 (&(((struct igc_adv_tx_context_desc *)((R)->desc))[i]))