blob: 97f348aa6ba41f3579dfac5bc1fa5bfecfb984ac [file] [log] [blame]
Carolyn Wybornye52c0f92014-04-11 01:46:06 +00001/* Intel(R) Gigabit Ethernet Linux driver
2 * Copyright(c) 2007-2014 Intel Corporation.
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, see <http://www.gnu.org/licenses/>.
15 *
16 * The full GNU General Public License is included in this distribution in
17 * the file called "COPYING".
18 *
19 * Contact Information:
20 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
21 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
22 */
Auke Kok9d5c8242008-01-24 02:22:38 -080023
24/* Linux PRO/1000 Ethernet Driver main header file */
25
26#ifndef _IGB_H_
27#define _IGB_H_
28
29#include "e1000_mac.h"
30#include "e1000_82575.h"
31
Richard Cochran74d23cc2014-12-21 19:46:56 +010032#include <linux/timecounter.h>
Patrick Ohly33af6bc2009-02-12 05:03:43 +000033#include <linux/net_tstamp.h>
Richard Cochrand339b132012-03-16 10:55:32 +000034#include <linux/ptp_clock_kernel.h>
Jiri Pirkob2cb09b2011-07-21 03:27:27 +000035#include <linux/bitops.h>
36#include <linux/if_vlan.h>
Carolyn Wyborny441fc6f2012-12-07 03:00:30 +000037#include <linux/i2c.h>
38#include <linux/i2c-algo-bit.h>
Carolyn Wybornycd14ef52013-12-10 07:58:34 +000039#include <linux/pci.h>
Carolyn Wybornyf4c01e92014-03-12 03:58:22 +000040#include <linux/mdio.h>
Patrick Ohly38c845c2009-02-12 05:03:41 +000041
Auke Kok9d5c8242008-01-24 02:22:38 -080042struct igb_adapter;
43
Jeff Kirsherb980ac12013-02-23 07:29:56 +000044#define E1000_PCS_CFG_IGN_SD 1
Carolyn Wyborny3860a0b2012-11-22 02:49:22 +000045
Alexander Duyck0ba82992011-08-26 07:45:47 +000046/* Interrupt defines */
Jeff Kirsherb980ac12013-02-23 07:29:56 +000047#define IGB_START_ITR 648 /* ~6000 ints/sec */
48#define IGB_4K_ITR 980
49#define IGB_20K_ITR 196
50#define IGB_70K_ITR 56
Auke Kok9d5c8242008-01-24 02:22:38 -080051
Auke Kok9d5c8242008-01-24 02:22:38 -080052/* TX/RX descriptor defines */
Jeff Kirsherb980ac12013-02-23 07:29:56 +000053#define IGB_DEFAULT_TXD 256
54#define IGB_DEFAULT_TX_WORK 128
55#define IGB_MIN_TXD 80
56#define IGB_MAX_TXD 4096
Auke Kok9d5c8242008-01-24 02:22:38 -080057
Jeff Kirsherb980ac12013-02-23 07:29:56 +000058#define IGB_DEFAULT_RXD 256
59#define IGB_MIN_RXD 80
60#define IGB_MAX_RXD 4096
Auke Kok9d5c8242008-01-24 02:22:38 -080061
Jeff Kirsherb980ac12013-02-23 07:29:56 +000062#define IGB_DEFAULT_ITR 3 /* dynamic */
63#define IGB_MAX_ITR_USECS 10000
64#define IGB_MIN_ITR_USECS 10
65#define NON_Q_VECTORS 1
66#define MAX_Q_VECTORS 8
Carolyn Wybornycd14ef52013-12-10 07:58:34 +000067#define MAX_MSIX_ENTRIES 10
Auke Kok9d5c8242008-01-24 02:22:38 -080068
69/* Transmit and receive queues */
Jeff Kirsherb980ac12013-02-23 07:29:56 +000070#define IGB_MAX_RX_QUEUES 8
71#define IGB_MAX_RX_QUEUES_82575 4
72#define IGB_MAX_RX_QUEUES_I211 2
73#define IGB_MAX_TX_QUEUES 8
74#define IGB_MAX_VF_MC_ENTRIES 30
75#define IGB_MAX_VF_FUNCTIONS 8
76#define IGB_MAX_VFTA_ENTRIES 128
77#define IGB_82576_VF_DEV_ID 0x10CA
78#define IGB_I350_VF_DEV_ID 0x1520
Alexander Duyck4ae196d2009-02-19 20:40:07 -080079
Carolyn Wybornyd67974f2012-06-14 16:04:19 +000080/* NVM version defines */
Jeff Kirsherb980ac12013-02-23 07:29:56 +000081#define IGB_MAJOR_MASK 0xF000
82#define IGB_MINOR_MASK 0x0FF0
83#define IGB_BUILD_MASK 0x000F
84#define IGB_COMB_VER_MASK 0x00FF
85#define IGB_MAJOR_SHIFT 12
86#define IGB_MINOR_SHIFT 4
87#define IGB_COMB_VER_SHFT 8
88#define IGB_NVM_VER_INVALID 0xFFFF
89#define IGB_ETRACK_SHIFT 16
90#define NVM_ETRACK_WORD 0x0042
91#define NVM_COMB_VER_OFF 0x0083
92#define NVM_COMB_VER_PTR 0x003d
Carolyn Wybornyd67974f2012-06-14 16:04:19 +000093
Nathan Sullivan3f544d22016-05-03 18:10:56 -050094/* Transmit and receive latency (for PTP timestamps) */
95#define IGB_I210_TX_LATENCY_10 9542
96#define IGB_I210_TX_LATENCY_100 1024
97#define IGB_I210_TX_LATENCY_1000 178
98#define IGB_I210_RX_LATENCY_10 20662
99#define IGB_I210_RX_LATENCY_100 2213
100#define IGB_I210_RX_LATENCY_1000 448
101
Alexander Duyck4ae196d2009-02-19 20:40:07 -0800102struct vf_data_storage {
103 unsigned char vf_mac_addresses[ETH_ALEN];
104 u16 vf_mc_hashes[IGB_MAX_VF_MC_ENTRIES];
105 u16 num_vf_mc_hashes;
Alexander Duyckf2ca0db2009-10-27 23:46:57 +0000106 u32 flags;
107 unsigned long last_nack;
Williams, Mitch A8151d292010-02-10 01:44:24 +0000108 u16 pf_vlan; /* When set, guest VLAN config not allowed. */
109 u16 pf_qos;
Lior Levy17dc5662011-02-08 02:28:46 +0000110 u16 tx_rate;
Lior Levy70ea4782013-03-03 20:27:48 +0000111 bool spoofchk_enabled;
Alexander Duyck4ae196d2009-02-19 20:40:07 -0800112};
113
Alexander Duyckf2ca0db2009-10-27 23:46:57 +0000114#define IGB_VF_FLAG_CTS 0x00000001 /* VF is clear to send data */
Alexander Duyck7d5753f2009-10-27 23:47:16 +0000115#define IGB_VF_FLAG_UNI_PROMISC 0x00000002 /* VF has unicast promisc */
116#define IGB_VF_FLAG_MULTI_PROMISC 0x00000004 /* VF has multicast promisc */
Williams, Mitch A8151d292010-02-10 01:44:24 +0000117#define IGB_VF_FLAG_PF_SET_MAC 0x00000008 /* PF has set MAC address */
Alexander Duyckf2ca0db2009-10-27 23:46:57 +0000118
Auke Kok9d5c8242008-01-24 02:22:38 -0800119/* RX descriptor control thresholds.
120 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
121 * descriptors available in its onboard memory.
122 * Setting this to 0 disables RX descriptor prefetch.
123 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
124 * available in host memory.
125 * If PTHRESH is 0, this should also be 0.
126 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
127 * descriptors until either it has this many to write back, or the
128 * ITR timer expires.
129 */
Carolyn Wybornyceb5f132013-04-18 22:21:30 +0000130#define IGB_RX_PTHRESH ((hw->mac.type == e1000_i354) ? 12 : 8)
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000131#define IGB_RX_HTHRESH 8
Carolyn Wybornyceb5f132013-04-18 22:21:30 +0000132#define IGB_TX_PTHRESH ((hw->mac.type == e1000_i354) ? 20 : 8)
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000133#define IGB_TX_HTHRESH 1
134#define IGB_RX_WTHRESH ((hw->mac.type == e1000_82576 && \
Carolyn Wybornycd14ef52013-12-10 07:58:34 +0000135 (adapter->flags & IGB_FLAG_HAS_MSIX)) ? 1 : 4)
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000136#define IGB_TX_WTHRESH ((hw->mac.type == e1000_82576 && \
Carolyn Wybornycd14ef52013-12-10 07:58:34 +0000137 (adapter->flags & IGB_FLAG_HAS_MSIX)) ? 1 : 16)
Auke Kok9d5c8242008-01-24 02:22:38 -0800138
139/* this is the size past which hardware will drop packets when setting LPE=0 */
140#define MAXIMUM_ETHERNET_VLAN_SIZE 1522
141
142/* Supported Rx Buffer Sizes */
Alexander Duyckde78d1f2012-09-25 00:31:12 +0000143#define IGB_RXBUFFER_256 256
144#define IGB_RXBUFFER_2048 2048
Alexander Duyck8649aae2017-02-06 18:27:03 -0800145#define IGB_RXBUFFER_3072 3072
Alexander Duyckde78d1f2012-09-25 00:31:12 +0000146#define IGB_RX_HDR_LEN IGB_RXBUFFER_256
Alexander Duyckcfbc8712017-02-06 18:26:15 -0800147#define IGB_TS_HDR_LEN 16
Auke Kok9d5c8242008-01-24 02:22:38 -0800148
Alexander Duyckcfbc8712017-02-06 18:26:15 -0800149#define IGB_SKB_PAD (NET_SKB_PAD + NET_IP_ALIGN)
150#if (PAGE_SIZE < 8192)
151#define IGB_MAX_FRAME_BUILD_SKB \
152 (SKB_WITH_OVERHEAD(IGB_RXBUFFER_2048) - IGB_SKB_PAD - IGB_TS_HDR_LEN)
153#else
154#define IGB_MAX_FRAME_BUILD_SKB (IGB_RXBUFFER_2048 - IGB_TS_HDR_LEN)
155#endif
156
Auke Kok9d5c8242008-01-24 02:22:38 -0800157/* How many Rx Buffers do we bundle into one write to the hardware ? */
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000158#define IGB_RX_BUFFER_WRITE 16 /* Must be power of 2 */
Auke Kok9d5c8242008-01-24 02:22:38 -0800159
Alexander Duyck7bd17592017-02-06 18:25:26 -0800160#define IGB_RX_DMA_ATTR \
161 (DMA_ATTR_SKIP_CPU_SYNC | DMA_ATTR_WEAK_ORDERING)
162
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000163#define AUTO_ALL_MODES 0
164#define IGB_EEPROM_APME 0x0400
Auke Kok9d5c8242008-01-24 02:22:38 -0800165
166#ifndef IGB_MASTER_SLAVE
167/* Switch to override PHY master/slave setting */
168#define IGB_MASTER_SLAVE e1000_ms_hw_default
169#endif
170
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000171#define IGB_MNG_VLAN_NONE -1
Auke Kok9d5c8242008-01-24 02:22:38 -0800172
Alexander Duyck1d9daf42012-11-13 04:03:23 +0000173enum igb_tx_flags {
174 /* cmd_type flags */
175 IGB_TX_FLAGS_VLAN = 0x01,
176 IGB_TX_FLAGS_TSO = 0x02,
177 IGB_TX_FLAGS_TSTAMP = 0x04,
178
179 /* olinfo flags */
180 IGB_TX_FLAGS_IPV4 = 0x10,
181 IGB_TX_FLAGS_CSUM = 0x20,
182};
183
184/* VLAN info */
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000185#define IGB_TX_FLAGS_VLAN_MASK 0xffff0000
Alexander Duyck2bbfebe2011-08-26 07:44:59 +0000186#define IGB_TX_FLAGS_VLAN_SHIFT 16
187
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000188/* The largest size we can write to the descriptor is 65535. In order to
Alexander Duyck21ba6fe2013-02-09 04:27:48 +0000189 * maintain a power of two alignment we have to limit ourselves to 32K.
190 */
191#define IGB_MAX_TXD_PWR 15
Jacob Kellera51d8c22016-04-13 16:08:28 -0700192#define IGB_MAX_DATA_PER_TXD (1u << IGB_MAX_TXD_PWR)
Alexander Duyck21ba6fe2013-02-09 04:27:48 +0000193
194/* Tx Descriptors needed, worst case */
195#define TXD_USE_COUNT(S) DIV_ROUND_UP((S), IGB_MAX_DATA_PER_TXD)
196#define DESC_NEEDED (MAX_SKB_FRAGS + 4)
197
Akeem G. Abodunrinf69aa392013-04-11 06:36:35 +0000198/* EEPROM byte offsets */
199#define IGB_SFF_8472_SWAP 0x5C
200#define IGB_SFF_8472_COMP 0x5E
201
202/* Bitmasks */
203#define IGB_SFF_ADDRESSING_MODE 0x4
204#define IGB_SFF_8472_UNSUP 0x00
205
Auke Kok9d5c8242008-01-24 02:22:38 -0800206/* wrapper around a pointer to a socket buffer,
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000207 * so a DMA handle can be stored along with the buffer
208 */
Alexander Duyck06034642011-08-26 07:44:22 +0000209struct igb_tx_buffer {
Alexander Duyck8542db02011-08-26 07:44:43 +0000210 union e1000_adv_tx_desc *next_to_watch;
Alexander Duyck06034642011-08-26 07:44:22 +0000211 unsigned long time_stamp;
Alexander Duyck06034642011-08-26 07:44:22 +0000212 struct sk_buff *skb;
213 unsigned int bytecount;
214 u16 gso_segs;
Alexander Duyck7af40ad92011-08-26 07:45:15 +0000215 __be16 protocol;
Carolyn Wyborny9005df32014-04-11 01:45:34 +0000216
Alexander Duyckc9f14bf32012-09-18 01:56:27 +0000217 DEFINE_DMA_UNMAP_ADDR(dma);
218 DEFINE_DMA_UNMAP_LEN(len);
Alexander Duyckebe42d12011-08-26 07:45:09 +0000219 u32 tx_flags;
Alexander Duyck06034642011-08-26 07:44:22 +0000220};
221
222struct igb_rx_buffer {
Auke Kok9d5c8242008-01-24 02:22:38 -0800223 dma_addr_t dma;
Alexander Duyck06034642011-08-26 07:44:22 +0000224 struct page *page;
Alexander Duyckbd4171a2016-12-14 15:05:34 -0800225#if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
226 __u32 page_offset;
227#else
228 __u16 page_offset;
229#endif
230 __u16 pagecnt_bias;
Auke Kok9d5c8242008-01-24 02:22:38 -0800231};
232
Jesper Dangaard Brouer8c0ab702009-05-26 13:50:31 +0000233struct igb_tx_queue_stats {
Auke Kok9d5c8242008-01-24 02:22:38 -0800234 u64 packets;
235 u64 bytes;
Alexander Duyck04a5fcaa2009-10-27 15:52:27 +0000236 u64 restart_queue;
Eric Dumazet12dcd862010-10-15 17:27:10 +0000237 u64 restart_queue2;
Auke Kok9d5c8242008-01-24 02:22:38 -0800238};
239
Jesper Dangaard Brouer8c0ab702009-05-26 13:50:31 +0000240struct igb_rx_queue_stats {
241 u64 packets;
242 u64 bytes;
243 u64 drops;
Alexander Duyck04a5fcaa2009-10-27 15:52:27 +0000244 u64 csum_err;
245 u64 alloc_failed;
Jesper Dangaard Brouer8c0ab702009-05-26 13:50:31 +0000246};
247
Alexander Duyck0ba82992011-08-26 07:45:47 +0000248struct igb_ring_container {
249 struct igb_ring *ring; /* pointer to linked list of rings */
250 unsigned int total_bytes; /* total bytes processed this int */
251 unsigned int total_packets; /* total packets processed this int */
252 u16 work_limit; /* total work allowed per interrupt */
253 u8 count; /* total number of rings in vector */
254 u8 itr; /* current ITR setting for ring */
255};
256
Alexander Duyck047e0032009-10-27 15:49:27 +0000257struct igb_ring {
Alexander Duyck238ac812011-08-26 07:43:48 +0000258 struct igb_q_vector *q_vector; /* backlink to q_vector */
259 struct net_device *netdev; /* back pointer to net_device */
260 struct device *dev; /* device pointer for dma mapping */
Alexander Duyck06034642011-08-26 07:44:22 +0000261 union { /* array of buffer info structs */
262 struct igb_tx_buffer *tx_buffer_info;
263 struct igb_rx_buffer *rx_buffer_info;
264 };
Alexander Duyck238ac812011-08-26 07:43:48 +0000265 void *desc; /* descriptor ring memory */
266 unsigned long flags; /* ring specific flags */
267 void __iomem *tail; /* pointer to ring tail register */
Alexander Duyck5536d212012-09-25 00:31:17 +0000268 dma_addr_t dma; /* phys address of the ring */
269 unsigned int size; /* length of desc. ring in bytes */
Alexander Duyck238ac812011-08-26 07:43:48 +0000270
271 u16 count; /* number of desc. in the ring */
272 u8 queue_index; /* logical index of the ring*/
273 u8 reg_idx; /* physical index of the ring */
Alexander Duyck238ac812011-08-26 07:43:48 +0000274
275 /* everything past this point are written often */
Alexander Duyck5536d212012-09-25 00:31:17 +0000276 u16 next_to_clean;
Auke Kok9d5c8242008-01-24 02:22:38 -0800277 u16 next_to_use;
Alexander Duyckcbc8e552012-09-25 00:31:02 +0000278 u16 next_to_alloc;
Auke Kok9d5c8242008-01-24 02:22:38 -0800279
Auke Kok9d5c8242008-01-24 02:22:38 -0800280 union {
281 /* TX */
282 struct {
Jesper Dangaard Brouer8c0ab702009-05-26 13:50:31 +0000283 struct igb_tx_queue_stats tx_stats;
Eric Dumazet12dcd862010-10-15 17:27:10 +0000284 struct u64_stats_sync tx_syncp;
285 struct u64_stats_sync tx_syncp2;
Auke Kok9d5c8242008-01-24 02:22:38 -0800286 };
287 /* RX */
288 struct {
Alexander Duyck1a1c2252012-09-25 00:30:52 +0000289 struct sk_buff *skb;
Jesper Dangaard Brouer8c0ab702009-05-26 13:50:31 +0000290 struct igb_rx_queue_stats rx_stats;
Eric Dumazet12dcd862010-10-15 17:27:10 +0000291 struct u64_stats_sync rx_syncp;
Auke Kok9d5c8242008-01-24 02:22:38 -0800292 };
293 };
Alexander Duyck5536d212012-09-25 00:31:17 +0000294} ____cacheline_internodealigned_in_smp;
295
296struct igb_q_vector {
297 struct igb_adapter *adapter; /* backlink */
298 int cpu; /* CPU for DCA */
299 u32 eims_value; /* EIMS mask value */
300
301 u16 itr_val;
302 u8 set_itr;
303 void __iomem *itr_register;
304
305 struct igb_ring_container rx, tx;
306
307 struct napi_struct napi;
308 struct rcu_head rcu; /* to avoid race with update stats on free */
309 char name[IFNAMSIZ + 9];
310
311 /* for dynamic allocation of rings associated with this q_vector */
312 struct igb_ring ring[0] ____cacheline_internodealigned_in_smp;
Auke Kok9d5c8242008-01-24 02:22:38 -0800313};
314
Alexander Duyck866cff02011-08-26 07:45:36 +0000315enum e1000_ring_flags_t {
Alexander Duyck8649aae2017-02-06 18:27:03 -0800316 IGB_RING_FLAG_RX_3K_BUFFER,
Alexander Duycke3cdf682017-02-06 18:27:14 -0800317 IGB_RING_FLAG_RX_BUILD_SKB_ENABLED,
Alexander Duyck866cff02011-08-26 07:45:36 +0000318 IGB_RING_FLAG_RX_SCTP_CSUM,
Alexander Duyck8be10e92011-08-26 07:47:11 +0000319 IGB_RING_FLAG_RX_LB_VLAN_BSWAP,
Alexander Duyck866cff02011-08-26 07:45:36 +0000320 IGB_RING_FLAG_TX_CTX_IDX,
321 IGB_RING_FLAG_TX_DETECT_HANG
322};
Alexander Duyck85ad76b2009-10-27 15:52:46 +0000323
Alexander Duyck8649aae2017-02-06 18:27:03 -0800324#define ring_uses_large_buffer(ring) \
325 test_bit(IGB_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
326#define set_ring_uses_large_buffer(ring) \
327 set_bit(IGB_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
328#define clear_ring_uses_large_buffer(ring) \
329 clear_bit(IGB_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
330
Alexander Duycke3cdf682017-02-06 18:27:14 -0800331#define ring_uses_build_skb(ring) \
332 test_bit(IGB_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
333#define set_ring_build_skb_enabled(ring) \
334 set_bit(IGB_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
335#define clear_ring_build_skb_enabled(ring) \
336 clear_bit(IGB_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
337
Alexander Duyck8649aae2017-02-06 18:27:03 -0800338static inline unsigned int igb_rx_bufsz(struct igb_ring *ring)
339{
340#if (PAGE_SIZE < 8192)
341 if (ring_uses_large_buffer(ring))
342 return IGB_RXBUFFER_3072;
Alexander Duycke3cdf682017-02-06 18:27:14 -0800343
344 if (ring_uses_build_skb(ring))
345 return IGB_MAX_FRAME_BUILD_SKB + IGB_TS_HDR_LEN;
Alexander Duyck8649aae2017-02-06 18:27:03 -0800346#endif
347 return IGB_RXBUFFER_2048;
348}
349
350static inline unsigned int igb_rx_pg_order(struct igb_ring *ring)
351{
352#if (PAGE_SIZE < 8192)
353 if (ring_uses_large_buffer(ring))
354 return 1;
355#endif
356 return 0;
357}
358
359#define igb_rx_pg_size(_ring) (PAGE_SIZE << igb_rx_pg_order(_ring))
360
Alexander Duycke032afc2011-08-26 07:44:48 +0000361#define IGB_TXD_DCMD (E1000_ADVTXD_DCMD_EOP | E1000_ADVTXD_DCMD_RS)
Alexander Duyck85ad76b2009-10-27 15:52:46 +0000362
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000363#define IGB_RX_DESC(R, i) \
Alexander Duyck601369062011-08-26 07:44:05 +0000364 (&(((union e1000_adv_rx_desc *)((R)->desc))[i]))
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000365#define IGB_TX_DESC(R, i) \
Alexander Duyck601369062011-08-26 07:44:05 +0000366 (&(((union e1000_adv_tx_desc *)((R)->desc))[i]))
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000367#define IGB_TX_CTXTDESC(R, i) \
Alexander Duyck601369062011-08-26 07:44:05 +0000368 (&(((struct e1000_adv_tx_context_desc *)((R)->desc))[i]))
Auke Kok9d5c8242008-01-24 02:22:38 -0800369
Alexander Duyck3ceb90f2011-08-26 07:46:03 +0000370/* igb_test_staterr - tests bits within Rx descriptor status and error fields */
371static inline __le32 igb_test_staterr(union e1000_adv_rx_desc *rx_desc,
372 const u32 stat_err_bits)
373{
374 return rx_desc->wb.upper.status_error & cpu_to_le32(stat_err_bits);
375}
376
Alexander Duyckd7ee5b32009-10-27 15:54:23 +0000377/* igb_desc_unused - calculate if we have unused descriptors */
378static inline int igb_desc_unused(struct igb_ring *ring)
379{
380 if (ring->next_to_clean > ring->next_to_use)
381 return ring->next_to_clean - ring->next_to_use - 1;
382
383 return ring->count + ring->next_to_clean - ring->next_to_use - 1;
384}
385
Carolyn Wybornye4288932012-12-07 03:01:42 +0000386#ifdef CONFIG_IGB_HWMON
387
388#define IGB_HWMON_TYPE_LOC 0
389#define IGB_HWMON_TYPE_TEMP 1
390#define IGB_HWMON_TYPE_CAUTION 2
391#define IGB_HWMON_TYPE_MAX 3
392
393struct hwmon_attr {
394 struct device_attribute dev_attr;
395 struct e1000_hw *hw;
396 struct e1000_thermal_diode_data *sensor;
397 char name[12];
398 };
399
400struct hwmon_buff {
Guenter Roecke3670b82013-11-26 07:15:23 +0000401 struct attribute_group group;
402 const struct attribute_group *groups[2];
403 struct attribute *attrs[E1000_MAX_SENSORS * 4 + 1];
404 struct hwmon_attr hwmon_list[E1000_MAX_SENSORS * 4];
Carolyn Wybornye4288932012-12-07 03:01:42 +0000405 unsigned int n_hwmon;
406 };
407#endif
408
Gangfeng Huang64c75d42016-07-06 13:22:55 +0800409/* The number of L2 ether-type filter registers, Index 3 is reserved
410 * for PTP 1588 timestamp
411 */
412#define MAX_ETYPE_FILTER (4 - 1)
413/* ETQF filter list: one static filter per filter consumer. This is
414 * to avoid filter collisions later. Add new filters here!!
415 *
416 * Current filters: Filter 3
417 */
418#define IGB_ETQF_FILTER_1588 3
419
Richard Cochran720db4f2014-11-21 20:51:26 +0000420#define IGB_N_EXTTS 2
421#define IGB_N_PEROUT 2
422#define IGB_N_SDP 4
Laura Mihaela Vasilescuc342b392013-07-31 20:19:48 +0000423#define IGB_RETA_SIZE 128
424
Gangfeng Huang0e71def2016-07-06 13:22:54 +0800425enum igb_filter_match_flags {
Gangfeng Huang64c75d42016-07-06 13:22:55 +0800426 IGB_FILTER_FLAG_ETHER_TYPE = 0x1,
Gangfeng Huang7a277a92016-07-06 13:22:56 +0800427 IGB_FILTER_FLAG_VLAN_TCI = 0x2,
Gangfeng Huang0e71def2016-07-06 13:22:54 +0800428};
429
430#define IGB_MAX_RXNFC_FILTERS 16
431
432/* RX network flow classification data structure */
433struct igb_nfc_input {
434 /* Byte layout in order, all values with MSB first:
Gangfeng Huang64c75d42016-07-06 13:22:55 +0800435 * match_flags - 1 byte
436 * etype - 2 bytes
Gangfeng Huang7a277a92016-07-06 13:22:56 +0800437 * vlan_tci - 2 bytes
Gangfeng Huang64c75d42016-07-06 13:22:55 +0800438 */
Gangfeng Huang0e71def2016-07-06 13:22:54 +0800439 u8 match_flags;
Gangfeng Huang64c75d42016-07-06 13:22:55 +0800440 __be16 etype;
Gangfeng Huang7a277a92016-07-06 13:22:56 +0800441 __be16 vlan_tci;
Gangfeng Huang0e71def2016-07-06 13:22:54 +0800442};
443
444struct igb_nfc_filter {
445 struct hlist_node nfc_node;
446 struct igb_nfc_input filter;
Gangfeng Huang64c75d42016-07-06 13:22:55 +0800447 u16 etype_reg_index;
Gangfeng Huang0e71def2016-07-06 13:22:54 +0800448 u16 sw_idx;
449 u16 action;
450};
451
Yury Kylulin83c21332017-03-07 11:20:25 +0300452struct igb_mac_addr {
453 u8 addr[ETH_ALEN];
454 u8 queue;
455 u8 state; /* bitmask */
456};
457
458#define IGB_MAC_STATE_DEFAULT 0x1
459#define IGB_MAC_STATE_IN_USE 0x2
460
Auke Kok9d5c8242008-01-24 02:22:38 -0800461/* board specific private data structure */
Auke Kok9d5c8242008-01-24 02:22:38 -0800462struct igb_adapter {
Jiri Pirkob2cb09b2011-07-21 03:27:27 +0000463 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
Alexander Duyck238ac812011-08-26 07:43:48 +0000464
465 struct net_device *netdev;
466
467 unsigned long state;
468 unsigned int flags;
469
470 unsigned int num_q_vectors;
Carolyn Wybornycd14ef52013-12-10 07:58:34 +0000471 struct msix_entry msix_entries[MAX_MSIX_ENTRIES];
Alexander Duyck2e5655e2009-10-27 23:50:38 +0000472
Auke Kok9d5c8242008-01-24 02:22:38 -0800473 /* Interrupt Throttle Rate */
Alexander Duyck4fc82ad2009-10-27 23:45:42 +0000474 u32 rx_itr_setting;
475 u32 tx_itr_setting;
Auke Kok9d5c8242008-01-24 02:22:38 -0800476 u16 tx_itr;
477 u16 rx_itr;
Auke Kok9d5c8242008-01-24 02:22:38 -0800478
Alexander Duyck238ac812011-08-26 07:43:48 +0000479 /* TX */
Alexander Duyck13fde972011-10-05 13:35:24 +0000480 u16 tx_work_limit;
Alexander Duyck238ac812011-08-26 07:43:48 +0000481 u32 tx_timeout_count;
482 int num_tx_queues;
483 struct igb_ring *tx_ring[16];
484
485 /* RX */
486 int num_rx_queues;
487 struct igb_ring *rx_ring[16];
488
489 u32 max_frame_size;
490 u32 min_frame_size;
491
492 struct timer_list watchdog_timer;
493 struct timer_list phy_info_timer;
494
495 u16 mng_vlan_id;
496 u32 bd_number;
497 u32 wol;
498 u32 en_mng_pt;
499 u16 link_speed;
500 u16 link_duplex;
501
Jarod Wilson73bf8042015-09-10 15:37:50 -0400502 u8 __iomem *io_addr; /* Mainly for iounmap use */
503
Auke Kok9d5c8242008-01-24 02:22:38 -0800504 struct work_struct reset_task;
505 struct work_struct watchdog_task;
506 bool fc_autoneg;
507 u8 tx_timeout_factor;
508 struct timer_list blink_timer;
509 unsigned long led_status;
510
Auke Kok9d5c8242008-01-24 02:22:38 -0800511 /* OS defined structs */
Auke Kok9d5c8242008-01-24 02:22:38 -0800512 struct pci_dev *pdev;
Auke Kok9d5c8242008-01-24 02:22:38 -0800513
Eric Dumazet12dcd862010-10-15 17:27:10 +0000514 spinlock_t stats64_lock;
515 struct rtnl_link_stats64 stats64;
516
Auke Kok9d5c8242008-01-24 02:22:38 -0800517 /* structs defined in e1000_hw.h */
518 struct e1000_hw hw;
519 struct e1000_hw_stats stats;
520 struct e1000_phy_info phy_info;
Auke Kok9d5c8242008-01-24 02:22:38 -0800521
522 u32 test_icr;
523 struct igb_ring test_tx_ring;
524 struct igb_ring test_rx_ring;
525
526 int msg_enable;
Alexander Duyck047e0032009-10-27 15:49:27 +0000527
Alexander Duyck047e0032009-10-27 15:49:27 +0000528 struct igb_q_vector *q_vector[MAX_Q_VECTORS];
Auke Kok9d5c8242008-01-24 02:22:38 -0800529 u32 eims_enable_mask;
PJ Waskiewicz844290e2008-06-27 11:00:39 -0700530 u32 eims_other;
Auke Kok9d5c8242008-01-24 02:22:38 -0800531
532 /* to not mess up cache alignment, always add to the bottom */
Alexander Duyck2e5655e2009-10-27 23:50:38 +0000533 u16 tx_ring_count;
534 u16 rx_ring_count;
Alexander Duyck1bfaf072009-02-19 20:39:23 -0800535 unsigned int vfs_allocated_count;
Alexander Duyck4ae196d2009-02-19 20:40:07 -0800536 struct vf_data_storage *vf_data;
Lior Levy17dc5662011-02-08 02:28:46 +0000537 int vf_rate_link_speed;
Alexander Duycka99955f2009-11-12 18:37:19 +0000538 u32 rss_queues;
Greg Rose13800462010-11-06 02:08:26 +0000539 u32 wvbr;
Carolyn Wyborny1128c752011-10-14 00:13:49 +0000540 u32 *shadow_vfta;
Richard Cochrand339b132012-03-16 10:55:32 +0000541
542 struct ptp_clock *ptp_clock;
Matthew Vicka79f4f82012-08-10 05:40:44 +0000543 struct ptp_clock_info ptp_caps;
544 struct delayed_work ptp_overflow_work;
Matthew Vick1f6e8172012-08-18 07:26:33 +0000545 struct work_struct ptp_tx_work;
546 struct sk_buff *ptp_tx_skb;
Jacob Keller6ab5f7b2014-01-11 07:20:06 +0000547 struct hwtstamp_config tstamp_config;
Matthew Vick428f1f72012-12-13 07:20:34 +0000548 unsigned long ptp_tx_start;
Matthew Vickfc580752012-12-13 07:20:35 +0000549 unsigned long last_rx_ptp_check;
Jakub Kicinski5499a962014-04-02 10:33:33 +0000550 unsigned long last_rx_timestamp;
Jacob Keller462f1182016-05-24 13:56:27 -0700551 unsigned int ptp_flags;
Richard Cochrand339b132012-03-16 10:55:32 +0000552 spinlock_t tmreg_lock;
553 struct cyclecounter cc;
554 struct timecounter tc;
Matthew Vick428f1f72012-12-13 07:20:34 +0000555 u32 tx_hwtstamp_timeouts;
Matthew Vickfc580752012-12-13 07:20:35 +0000556 u32 rx_hwtstamp_cleared;
Jacob Kellerac28b412016-09-09 09:10:51 -0700557 bool pps_sys_wrap_on;
Matthew Vick3c89f6d2012-08-10 05:40:43 +0000558
Richard Cochran720db4f2014-11-21 20:51:26 +0000559 struct ptp_pin_desc sdp_config[IGB_N_SDP];
560 struct {
Arnd Bergmann40c9b072015-09-30 13:26:33 +0200561 struct timespec64 start;
562 struct timespec64 period;
Richard Cochran720db4f2014-11-21 20:51:26 +0000563 } perout[IGB_N_PEROUT];
564
Carolyn Wybornyd67974f2012-06-14 16:04:19 +0000565 char fw_version[32];
Carolyn Wybornye4288932012-12-07 03:01:42 +0000566#ifdef CONFIG_IGB_HWMON
Guenter Roecke3670b82013-11-26 07:15:23 +0000567 struct hwmon_buff *igb_hwmon_buff;
Carolyn Wybornye4288932012-12-07 03:01:42 +0000568 bool ets;
569#endif
Carolyn Wyborny441fc6f2012-12-07 03:00:30 +0000570 struct i2c_algo_bit_data i2c_algo;
571 struct i2c_adapter i2c_adap;
Carolyn Wyborny603e86f2013-02-20 07:40:55 +0000572 struct i2c_client *i2c_client;
Laura Mihaela Vasilescued12cc92013-07-31 20:19:54 +0000573 u32 rss_indir_tbl_init;
574 u8 rss_indir_tbl[IGB_RETA_SIZE];
Akeem G Abodunrinaa9b8cc2013-08-28 02:22:43 +0000575
576 unsigned long link_check_timeout;
Carolyn Wyborny56cec242013-10-17 05:36:26 +0000577 int copper_tries;
578 struct e1000_info ei;
Carolyn Wybornyf4c01e92014-03-12 03:58:22 +0000579 u16 eee_advert;
Gangfeng Huang0e71def2016-07-06 13:22:54 +0800580
581 /* RX network flow classification support */
582 struct hlist_head nfc_filter_list;
583 unsigned int nfc_filter_count;
584 /* lock for RX network flow classification filter */
585 spinlock_t nfc_lock;
Gangfeng Huang64c75d42016-07-06 13:22:55 +0800586 bool etype_bitmap[MAX_ETYPE_FILTER];
Yury Kylulin83c21332017-03-07 11:20:25 +0300587
588 struct igb_mac_addr *mac_table;
Auke Kok9d5c8242008-01-24 02:22:38 -0800589};
590
Jacob Keller462f1182016-05-24 13:56:27 -0700591/* flags controlling PTP/1588 function */
592#define IGB_PTP_ENABLED BIT(0)
Jacob Keller63737162016-05-24 13:56:28 -0700593#define IGB_PTP_OVERFLOW_CHECK BIT(1)
Jacob Keller462f1182016-05-24 13:56:27 -0700594
Jacob Kellera51d8c22016-04-13 16:08:28 -0700595#define IGB_FLAG_HAS_MSI BIT(0)
596#define IGB_FLAG_DCA_ENABLED BIT(1)
597#define IGB_FLAG_QUAD_PORT_A BIT(2)
598#define IGB_FLAG_QUEUE_PAIRS BIT(3)
599#define IGB_FLAG_DMAC BIT(4)
Jacob Kellera51d8c22016-04-13 16:08:28 -0700600#define IGB_FLAG_RSS_FIELD_IPV4_UDP BIT(6)
601#define IGB_FLAG_RSS_FIELD_IPV6_UDP BIT(7)
602#define IGB_FLAG_WOL_SUPPORTED BIT(8)
603#define IGB_FLAG_NEED_LINK_UPDATE BIT(9)
604#define IGB_FLAG_MEDIA_RESET BIT(10)
605#define IGB_FLAG_MAS_CAPABLE BIT(11)
606#define IGB_FLAG_MAS_ENABLE BIT(12)
607#define IGB_FLAG_HAS_MSIX BIT(13)
608#define IGB_FLAG_EEE BIT(14)
Alexander Duyck16903ca2016-01-06 23:11:18 -0800609#define IGB_FLAG_VLAN_PROMISC BIT(15)
Alexander Duycke0891292017-02-06 18:26:52 -0800610#define IGB_FLAG_RX_LEGACY BIT(16)
Carolyn Wyborny56cec242013-10-17 05:36:26 +0000611
612/* Media Auto Sense */
613#define IGB_MAS_ENABLE_0 0X0001
614#define IGB_MAS_ENABLE_1 0X0002
615#define IGB_MAS_ENABLE_2 0X0004
616#define IGB_MAS_ENABLE_3 0X0008
Carolyn Wyborny831ec0b2011-03-11 20:43:54 -0800617
618/* DMA Coalescing defines */
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000619#define IGB_MIN_TXPBSIZE 20408
620#define IGB_TX_BUF_4096 4096
621#define IGB_DMCTLX_DCFLUSH_DIS 0x80000000 /* Disable DMA Coal Flush */
Alexander Duyck7dfc16f2008-07-08 15:10:46 -0700622
Jeff Kirsherb980ac12013-02-23 07:29:56 +0000623#define IGB_82576_TSYNC_SHIFT 19
Auke Kok9d5c8242008-01-24 02:22:38 -0800624enum e1000_state_t {
625 __IGB_TESTING,
626 __IGB_RESETTING,
Jakub Kicinskied4420a2014-03-15 14:55:32 +0000627 __IGB_DOWN,
628 __IGB_PTP_TX_IN_PROGRESS,
Auke Kok9d5c8242008-01-24 02:22:38 -0800629};
630
631enum igb_boards {
632 board_82575,
633};
634
635extern char igb_driver_name[];
636extern char igb_driver_version[];
637
Stefan Assmann46eafa52016-02-03 09:20:50 +0100638int igb_open(struct net_device *netdev);
639int igb_close(struct net_device *netdev);
Joe Perches5ccc9212013-09-23 11:37:59 -0700640int igb_up(struct igb_adapter *);
641void igb_down(struct igb_adapter *);
642void igb_reinit_locked(struct igb_adapter *);
643void igb_reset(struct igb_adapter *);
Laura Mihaela Vasilescu907b7832013-10-01 04:33:56 -0700644int igb_reinit_queues(struct igb_adapter *);
Joe Perches5ccc9212013-09-23 11:37:59 -0700645void igb_write_rss_indir_tbl(struct igb_adapter *);
646int igb_set_spd_dplx(struct igb_adapter *, u32, u8);
647int igb_setup_tx_resources(struct igb_ring *);
648int igb_setup_rx_resources(struct igb_ring *);
649void igb_free_tx_resources(struct igb_ring *);
650void igb_free_rx_resources(struct igb_ring *);
651void igb_configure_tx_ring(struct igb_adapter *, struct igb_ring *);
652void igb_configure_rx_ring(struct igb_adapter *, struct igb_ring *);
653void igb_setup_tctl(struct igb_adapter *);
654void igb_setup_rctl(struct igb_adapter *);
655netdev_tx_t igb_xmit_frame_ring(struct sk_buff *, struct igb_ring *);
Joe Perches5ccc9212013-09-23 11:37:59 -0700656void igb_alloc_rx_buffers(struct igb_ring *, u16);
657void igb_update_stats(struct igb_adapter *, struct rtnl_link_stats64 *);
658bool igb_has_link(struct igb_adapter *adapter);
659void igb_set_ethtool_ops(struct net_device *);
660void igb_power_up_link(struct igb_adapter *);
661void igb_set_fw_version(struct igb_adapter *);
662void igb_ptp_init(struct igb_adapter *adapter);
663void igb_ptp_stop(struct igb_adapter *adapter);
664void igb_ptp_reset(struct igb_adapter *adapter);
Jacob Kellere3f23502016-05-24 13:56:30 -0700665void igb_ptp_suspend(struct igb_adapter *adapter);
Joe Perches5ccc9212013-09-23 11:37:59 -0700666void igb_ptp_rx_hang(struct igb_adapter *adapter);
Joe Perches5ccc9212013-09-23 11:37:59 -0700667void igb_ptp_rx_rgtstamp(struct igb_q_vector *q_vector, struct sk_buff *skb);
Alexander Duyck3456fd52017-02-06 18:26:40 -0800668void igb_ptp_rx_pktstamp(struct igb_q_vector *q_vector, void *va,
Joe Perches5ccc9212013-09-23 11:37:59 -0700669 struct sk_buff *skb);
Jacob Keller6ab5f7b2014-01-11 07:20:06 +0000670int igb_ptp_set_ts_config(struct net_device *netdev, struct ifreq *ifr);
671int igb_ptp_get_ts_config(struct net_device *netdev, struct ifreq *ifr);
Shota Suzuki72ddef02015-07-01 09:25:52 +0900672void igb_set_flag_queue_pairs(struct igb_adapter *, const u32);
Carolyn Wybornye4288932012-12-07 03:01:42 +0000673#ifdef CONFIG_IGB_HWMON
Joe Perches5ccc9212013-09-23 11:37:59 -0700674void igb_sysfs_exit(struct igb_adapter *adapter);
675int igb_sysfs_init(struct igb_adapter *adapter);
Carolyn Wybornye4288932012-12-07 03:01:42 +0000676#endif
Alexander Duyckf5f4cf02008-11-21 21:30:24 -0800677static inline s32 igb_reset_phy(struct e1000_hw *hw)
678{
Alexander Duycka8d2a0c2009-02-06 23:17:26 +0000679 if (hw->phy.ops.reset)
680 return hw->phy.ops.reset(hw);
Alexander Duyckf5f4cf02008-11-21 21:30:24 -0800681
682 return 0;
683}
684
685static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
686{
Alexander Duycka8d2a0c2009-02-06 23:17:26 +0000687 if (hw->phy.ops.read_reg)
688 return hw->phy.ops.read_reg(hw, offset, data);
Alexander Duyckf5f4cf02008-11-21 21:30:24 -0800689
690 return 0;
691}
692
693static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
694{
Alexander Duycka8d2a0c2009-02-06 23:17:26 +0000695 if (hw->phy.ops.write_reg)
696 return hw->phy.ops.write_reg(hw, offset, data);
Alexander Duyckf5f4cf02008-11-21 21:30:24 -0800697
698 return 0;
699}
700
701static inline s32 igb_get_phy_info(struct e1000_hw *hw)
702{
703 if (hw->phy.ops.get_phy_info)
704 return hw->phy.ops.get_phy_info(hw);
705
706 return 0;
707}
708
Eric Dumazetbdbc0632012-01-04 20:23:36 +0000709static inline struct netdev_queue *txring_txq(const struct igb_ring *tx_ring)
710{
711 return netdev_get_tx_queue(tx_ring->netdev, tx_ring->queue_index);
712}
713
Gangfeng Huang0e71def2016-07-06 13:22:54 +0800714int igb_add_filter(struct igb_adapter *adapter,
715 struct igb_nfc_filter *input);
716int igb_erase_filter(struct igb_adapter *adapter,
717 struct igb_nfc_filter *input);
718
Auke Kok9d5c8242008-01-24 02:22:38 -0800719#endif /* _IGB_H_ */