1 /*******************************************************************************
2 
3   Intel 10 Gigabit PCI Express Linux driver
4   Copyright(c) 1999 - 2013 Intel Corporation.
5 
6   This program is free software; you can redistribute it and/or modify it
7   under the terms and conditions of the GNU General Public License,
8   version 2, as published by the Free Software Foundation.
9 
10   This program is distributed in the hope it will be useful, but WITHOUT
11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13   more details.
14 
15   You should have received a copy of the GNU General Public License along with
16   this program; if not, write to the Free Software Foundation, Inc.,
17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18 
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21 
22   Contact Information:
23   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
24   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25 
26 *******************************************************************************/
27 
28 #ifndef _IXGBE_H_
29 #define _IXGBE_H_
30 
31 #include <linux/bitops.h>
32 #include <linux/types.h>
33 #include <linux/pci.h>
34 #include <linux/netdevice.h>
35 #include <linux/cpumask.h>
36 #include <linux/aer.h>
37 #include <linux/if_vlan.h>
38 #include <linux/jiffies.h>
39 
40 #include <linux/clocksource.h>
41 #include <linux/net_tstamp.h>
42 #include <linux/ptp_clock_kernel.h>
43 
44 #include "ixgbe_type.h"
45 #include "ixgbe_common.h"
46 #include "ixgbe_dcb.h"
47 #if defined(CONFIG_FCOE) || defined(CONFIG_FCOE_MODULE)
48 #define IXGBE_FCOE
49 #include "ixgbe_fcoe.h"
50 #endif /* CONFIG_FCOE or CONFIG_FCOE_MODULE */
51 #ifdef CONFIG_IXGBE_DCA
52 #include <linux/dca.h>
53 #endif
54 
55 #include <net/busy_poll.h>
56 
57 #ifdef CONFIG_NET_RX_BUSY_POLL
58 #define BP_EXTENDED_STATS
59 #endif
60 /* common prefix used by pr_<> macros */
61 #undef pr_fmt
62 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
63 
64 /* TX/RX descriptor defines */
65 #define IXGBE_DEFAULT_TXD		    512
66 #define IXGBE_DEFAULT_TX_WORK		    256
67 #define IXGBE_MAX_TXD			   4096
68 #define IXGBE_MIN_TXD			     64
69 
70 #if (PAGE_SIZE < 8192)
71 #define IXGBE_DEFAULT_RXD		    512
72 #else
73 #define IXGBE_DEFAULT_RXD		    128
74 #endif
75 #define IXGBE_MAX_RXD			   4096
76 #define IXGBE_MIN_RXD			     64
77 
78 /* flow control */
79 #define IXGBE_MIN_FCRTL			   0x40
80 #define IXGBE_MAX_FCRTL			0x7FF80
81 #define IXGBE_MIN_FCRTH			  0x600
82 #define IXGBE_MAX_FCRTH			0x7FFF0
83 #define IXGBE_DEFAULT_FCPAUSE		 0xFFFF
84 #define IXGBE_MIN_FCPAUSE		      0
85 #define IXGBE_MAX_FCPAUSE		 0xFFFF
86 
87 /* Supported Rx Buffer Sizes */
88 #define IXGBE_RXBUFFER_256    256  /* Used for skb receive header */
89 #define IXGBE_RXBUFFER_2K    2048
90 #define IXGBE_RXBUFFER_3K    3072
91 #define IXGBE_RXBUFFER_4K    4096
92 #define IXGBE_MAX_RXBUFFER  16384  /* largest size for a single descriptor */
93 
94 /*
95  * NOTE: netdev_alloc_skb reserves up to 64 bytes, NET_IP_ALIGN means we
96  * reserve 64 more, and skb_shared_info adds an additional 320 bytes more,
97  * this adds up to 448 bytes of extra data.
98  *
99  * Since netdev_alloc_skb now allocates a page fragment we can use a value
100  * of 256 and the resultant skb will have a truesize of 960 or less.
101  */
102 #define IXGBE_RX_HDR_SIZE IXGBE_RXBUFFER_256
103 
104 /* How many Rx Buffers do we bundle into one write to the hardware ? */
105 #define IXGBE_RX_BUFFER_WRITE	16	/* Must be power of 2 */
106 
107 enum ixgbe_tx_flags {
108 	/* cmd_type flags */
109 	IXGBE_TX_FLAGS_HW_VLAN	= 0x01,
110 	IXGBE_TX_FLAGS_TSO	= 0x02,
111 	IXGBE_TX_FLAGS_TSTAMP	= 0x04,
112 
113 	/* olinfo flags */
114 	IXGBE_TX_FLAGS_CC	= 0x08,
115 	IXGBE_TX_FLAGS_IPV4	= 0x10,
116 	IXGBE_TX_FLAGS_CSUM	= 0x20,
117 
118 	/* software defined flags */
119 	IXGBE_TX_FLAGS_SW_VLAN	= 0x40,
120 	IXGBE_TX_FLAGS_FCOE	= 0x80,
121 };
122 
123 /* VLAN info */
124 #define IXGBE_TX_FLAGS_VLAN_MASK	0xffff0000
125 #define IXGBE_TX_FLAGS_VLAN_PRIO_MASK	0xe0000000
126 #define IXGBE_TX_FLAGS_VLAN_PRIO_SHIFT  29
127 #define IXGBE_TX_FLAGS_VLAN_SHIFT	16
128 
129 #define IXGBE_MAX_VF_MC_ENTRIES         30
130 #define IXGBE_MAX_VF_FUNCTIONS          64
131 #define IXGBE_MAX_VFTA_ENTRIES          128
132 #define MAX_EMULATION_MAC_ADDRS         16
133 #define IXGBE_MAX_PF_MACVLANS           15
134 #define VMDQ_P(p)   ((p) + adapter->ring_feature[RING_F_VMDQ].offset)
135 #define IXGBE_82599_VF_DEVICE_ID        0x10ED
136 #define IXGBE_X540_VF_DEVICE_ID         0x1515
137 
138 struct vf_data_storage {
139 	unsigned char vf_mac_addresses[ETH_ALEN];
140 	u16 vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
141 	u16 num_vf_mc_hashes;
142 	u16 default_vf_vlan_id;
143 	u16 vlans_enabled;
144 	bool clear_to_send;
145 	bool pf_set_mac;
146 	u16 pf_vlan; /* When set, guest VLAN config not allowed. */
147 	u16 pf_qos;
148 	u16 tx_rate;
149 	u16 vlan_count;
150 	u8 spoofchk_enabled;
151 	unsigned int vf_api;
152 };
153 
154 struct vf_macvlans {
155 	struct list_head l;
156 	int vf;
157 	int rar_entry;
158 	bool free;
159 	bool is_macvlan;
160 	u8 vf_macvlan[ETH_ALEN];
161 };
162 
163 #define IXGBE_MAX_TXD_PWR	14
164 #define IXGBE_MAX_DATA_PER_TXD	(1 << IXGBE_MAX_TXD_PWR)
165 
166 /* Tx Descriptors needed, worst case */
167 #define TXD_USE_COUNT(S) DIV_ROUND_UP((S), IXGBE_MAX_DATA_PER_TXD)
168 #define DESC_NEEDED (MAX_SKB_FRAGS + 4)
169 
170 /* wrapper around a pointer to a socket buffer,
171  * so a DMA handle can be stored along with the buffer */
172 struct ixgbe_tx_buffer {
173 	union ixgbe_adv_tx_desc *next_to_watch;
174 	unsigned long time_stamp;
175 	struct sk_buff *skb;
176 	unsigned int bytecount;
177 	unsigned short gso_segs;
178 	__be16 protocol;
179 	DEFINE_DMA_UNMAP_ADDR(dma);
180 	DEFINE_DMA_UNMAP_LEN(len);
181 	u32 tx_flags;
182 };
183 
184 struct ixgbe_rx_buffer {
185 	struct sk_buff *skb;
186 	dma_addr_t dma;
187 	struct page *page;
188 	unsigned int page_offset;
189 };
190 
191 struct ixgbe_queue_stats {
192 	u64 packets;
193 	u64 bytes;
194 #ifdef BP_EXTENDED_STATS
195 	u64 yields;
196 	u64 misses;
197 	u64 cleaned;
198 #endif  /* BP_EXTENDED_STATS */
199 };
200 
201 struct ixgbe_tx_queue_stats {
202 	u64 restart_queue;
203 	u64 tx_busy;
204 	u64 tx_done_old;
205 };
206 
207 struct ixgbe_rx_queue_stats {
208 	u64 rsc_count;
209 	u64 rsc_flush;
210 	u64 non_eop_descs;
211 	u64 alloc_rx_page_failed;
212 	u64 alloc_rx_buff_failed;
213 	u64 csum_err;
214 };
215 
216 enum ixgbe_ring_state_t {
217 	__IXGBE_TX_FDIR_INIT_DONE,
218 	__IXGBE_TX_XPS_INIT_DONE,
219 	__IXGBE_TX_DETECT_HANG,
220 	__IXGBE_HANG_CHECK_ARMED,
221 	__IXGBE_RX_RSC_ENABLED,
222 	__IXGBE_RX_CSUM_UDP_ZERO_ERR,
223 	__IXGBE_RX_FCOE,
224 };
225 
226 struct ixgbe_fwd_adapter {
227 	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
228 	struct net_device *netdev;
229 	struct ixgbe_adapter *real_adapter;
230 	unsigned int tx_base_queue;
231 	unsigned int rx_base_queue;
232 	int pool;
233 };
234 
235 #define check_for_tx_hang(ring) \
236 	test_bit(__IXGBE_TX_DETECT_HANG, &(ring)->state)
237 #define set_check_for_tx_hang(ring) \
238 	set_bit(__IXGBE_TX_DETECT_HANG, &(ring)->state)
239 #define clear_check_for_tx_hang(ring) \
240 	clear_bit(__IXGBE_TX_DETECT_HANG, &(ring)->state)
241 #define ring_is_rsc_enabled(ring) \
242 	test_bit(__IXGBE_RX_RSC_ENABLED, &(ring)->state)
243 #define set_ring_rsc_enabled(ring) \
244 	set_bit(__IXGBE_RX_RSC_ENABLED, &(ring)->state)
245 #define clear_ring_rsc_enabled(ring) \
246 	clear_bit(__IXGBE_RX_RSC_ENABLED, &(ring)->state)
247 struct ixgbe_ring {
248 	struct ixgbe_ring *next;	/* pointer to next ring in q_vector */
249 	struct ixgbe_q_vector *q_vector; /* backpointer to host q_vector */
250 	struct net_device *netdev;	/* netdev ring belongs to */
251 	struct device *dev;		/* device for DMA mapping */
252 	struct ixgbe_fwd_adapter *l2_accel_priv;
253 	void *desc;			/* descriptor ring memory */
254 	union {
255 		struct ixgbe_tx_buffer *tx_buffer_info;
256 		struct ixgbe_rx_buffer *rx_buffer_info;
257 	};
258 	unsigned long last_rx_timestamp;
259 	unsigned long state;
260 	u8 __iomem *tail;
261 	dma_addr_t dma;			/* phys. address of descriptor ring */
262 	unsigned int size;		/* length in bytes */
263 
264 	u16 count;			/* amount of descriptors */
265 
266 	u8 queue_index; /* needed for multiqueue queue management */
267 	u8 reg_idx;			/* holds the special value that gets
268 					 * the hardware register offset
269 					 * associated with this ring, which is
270 					 * different for DCB and RSS modes
271 					 */
272 	u16 next_to_use;
273 	u16 next_to_clean;
274 
275 	union {
276 		u16 next_to_alloc;
277 		struct {
278 			u8 atr_sample_rate;
279 			u8 atr_count;
280 		};
281 	};
282 
283 	u8 dcb_tc;
284 	struct ixgbe_queue_stats stats;
285 	struct u64_stats_sync syncp;
286 	union {
287 		struct ixgbe_tx_queue_stats tx_stats;
288 		struct ixgbe_rx_queue_stats rx_stats;
289 	};
290 } ____cacheline_internodealigned_in_smp;
291 
292 enum ixgbe_ring_f_enum {
293 	RING_F_NONE = 0,
294 	RING_F_VMDQ,  /* SR-IOV uses the same ring feature */
295 	RING_F_RSS,
296 	RING_F_FDIR,
297 #ifdef IXGBE_FCOE
298 	RING_F_FCOE,
299 #endif /* IXGBE_FCOE */
300 
301 	RING_F_ARRAY_SIZE      /* must be last in enum set */
302 };
303 
304 #define IXGBE_MAX_RSS_INDICES  16
305 #define IXGBE_MAX_VMDQ_INDICES 64
306 #define IXGBE_MAX_FDIR_INDICES 63	/* based on q_vector limit */
307 #define IXGBE_MAX_FCOE_INDICES  8
308 #define MAX_RX_QUEUES (IXGBE_MAX_FDIR_INDICES + 1)
309 #define MAX_TX_QUEUES (IXGBE_MAX_FDIR_INDICES + 1)
310 #define IXGBE_MAX_L2A_QUEUES 4
311 #define IXGBE_MAX_L2A_QUEUES 4
312 #define IXGBE_BAD_L2A_QUEUE 3
313 #define IXGBE_MAX_MACVLANS	31
314 #define IXGBE_MAX_DCBMACVLANS	8
315 
316 struct ixgbe_ring_feature {
317 	u16 limit;	/* upper limit on feature indices */
318 	u16 indices;	/* current value of indices */
319 	u16 mask;	/* Mask used for feature to ring mapping */
320 	u16 offset;	/* offset to start of feature */
321 } ____cacheline_internodealigned_in_smp;
322 
323 #define IXGBE_82599_VMDQ_8Q_MASK 0x78
324 #define IXGBE_82599_VMDQ_4Q_MASK 0x7C
325 #define IXGBE_82599_VMDQ_2Q_MASK 0x7E
326 
327 /*
328  * FCoE requires that all Rx buffers be over 2200 bytes in length.  Since
329  * this is twice the size of a half page we need to double the page order
330  * for FCoE enabled Rx queues.
331  */
332 static inline unsigned int ixgbe_rx_bufsz(struct ixgbe_ring *ring)
333 {
334 #ifdef IXGBE_FCOE
335 	if (test_bit(__IXGBE_RX_FCOE, &ring->state))
336 		return (PAGE_SIZE < 8192) ? IXGBE_RXBUFFER_4K :
337 					    IXGBE_RXBUFFER_3K;
338 #endif
339 	return IXGBE_RXBUFFER_2K;
340 }
341 
342 static inline unsigned int ixgbe_rx_pg_order(struct ixgbe_ring *ring)
343 {
344 #ifdef IXGBE_FCOE
345 	if (test_bit(__IXGBE_RX_FCOE, &ring->state))
346 		return (PAGE_SIZE < 8192) ? 1 : 0;
347 #endif
348 	return 0;
349 }
350 #define ixgbe_rx_pg_size(_ring) (PAGE_SIZE << ixgbe_rx_pg_order(_ring))
351 
352 struct ixgbe_ring_container {
353 	struct ixgbe_ring *ring;	/* pointer to linked list of rings */
354 	unsigned int total_bytes;	/* total bytes processed this int */
355 	unsigned int total_packets;	/* total packets processed this int */
356 	u16 work_limit;			/* total work allowed per interrupt */
357 	u8 count;			/* total number of rings in vector */
358 	u8 itr;				/* current ITR setting for ring */
359 };
360 
361 /* iterator for handling rings in ring container */
362 #define ixgbe_for_each_ring(pos, head) \
363 	for (pos = (head).ring; pos != NULL; pos = pos->next)
364 
365 #define MAX_RX_PACKET_BUFFERS ((adapter->flags & IXGBE_FLAG_DCB_ENABLED) \
366                               ? 8 : 1)
367 #define MAX_TX_PACKET_BUFFERS MAX_RX_PACKET_BUFFERS
368 
369 /* MAX_Q_VECTORS of these are allocated,
370  * but we only use one per queue-specific vector.
371  */
372 struct ixgbe_q_vector {
373 	struct ixgbe_adapter *adapter;
374 #ifdef CONFIG_IXGBE_DCA
375 	int cpu;	    /* CPU for DCA */
376 #endif
377 	u16 v_idx;		/* index of q_vector within array, also used for
378 				 * finding the bit in EICR and friends that
379 				 * represents the vector for this ring */
380 	u16 itr;		/* Interrupt throttle rate written to EITR */
381 	struct ixgbe_ring_container rx, tx;
382 
383 	struct napi_struct napi;
384 	cpumask_t affinity_mask;
385 	int numa_node;
386 	struct rcu_head rcu;	/* to avoid race with update stats on free */
387 	char name[IFNAMSIZ + 9];
388 
389 #ifdef CONFIG_NET_RX_BUSY_POLL
390 	unsigned int state;
391 #define IXGBE_QV_STATE_IDLE        0
392 #define IXGBE_QV_STATE_NAPI	   1     /* NAPI owns this QV */
393 #define IXGBE_QV_STATE_POLL	   2     /* poll owns this QV */
394 #define IXGBE_QV_STATE_DISABLED	   4     /* QV is disabled */
395 #define IXGBE_QV_OWNED (IXGBE_QV_STATE_NAPI | IXGBE_QV_STATE_POLL)
396 #define IXGBE_QV_LOCKED (IXGBE_QV_OWNED | IXGBE_QV_STATE_DISABLED)
397 #define IXGBE_QV_STATE_NAPI_YIELD  8     /* NAPI yielded this QV */
398 #define IXGBE_QV_STATE_POLL_YIELD  16    /* poll yielded this QV */
399 #define IXGBE_QV_YIELD (IXGBE_QV_STATE_NAPI_YIELD | IXGBE_QV_STATE_POLL_YIELD)
400 #define IXGBE_QV_USER_PEND (IXGBE_QV_STATE_POLL | IXGBE_QV_STATE_POLL_YIELD)
401 	spinlock_t lock;
402 #endif  /* CONFIG_NET_RX_BUSY_POLL */
403 
404 	/* for dynamic allocation of rings associated with this q_vector */
405 	struct ixgbe_ring ring[0] ____cacheline_internodealigned_in_smp;
406 };
407 #ifdef CONFIG_NET_RX_BUSY_POLL
408 static inline void ixgbe_qv_init_lock(struct ixgbe_q_vector *q_vector)
409 {
410 
411 	spin_lock_init(&q_vector->lock);
412 	q_vector->state = IXGBE_QV_STATE_IDLE;
413 }
414 
415 /* called from the device poll routine to get ownership of a q_vector */
416 static inline bool ixgbe_qv_lock_napi(struct ixgbe_q_vector *q_vector)
417 {
418 	int rc = true;
419 	spin_lock_bh(&q_vector->lock);
420 	if (q_vector->state & IXGBE_QV_LOCKED) {
421 		WARN_ON(q_vector->state & IXGBE_QV_STATE_NAPI);
422 		q_vector->state |= IXGBE_QV_STATE_NAPI_YIELD;
423 		rc = false;
424 #ifdef BP_EXTENDED_STATS
425 		q_vector->tx.ring->stats.yields++;
426 #endif
427 	} else
428 		/* we don't care if someone yielded */
429 		q_vector->state = IXGBE_QV_STATE_NAPI;
430 	spin_unlock_bh(&q_vector->lock);
431 	return rc;
432 }
433 
434 /* returns true is someone tried to get the qv while napi had it */
435 static inline bool ixgbe_qv_unlock_napi(struct ixgbe_q_vector *q_vector)
436 {
437 	int rc = false;
438 	spin_lock_bh(&q_vector->lock);
439 	WARN_ON(q_vector->state & (IXGBE_QV_STATE_POLL |
440 			       IXGBE_QV_STATE_NAPI_YIELD));
441 
442 	if (q_vector->state & IXGBE_QV_STATE_POLL_YIELD)
443 		rc = true;
444 	/* will reset state to idle, unless QV is disabled */
445 	q_vector->state &= IXGBE_QV_STATE_DISABLED;
446 	spin_unlock_bh(&q_vector->lock);
447 	return rc;
448 }
449 
450 /* called from ixgbe_low_latency_poll() */
451 static inline bool ixgbe_qv_lock_poll(struct ixgbe_q_vector *q_vector)
452 {
453 	int rc = true;
454 	spin_lock_bh(&q_vector->lock);
455 	if ((q_vector->state & IXGBE_QV_LOCKED)) {
456 		q_vector->state |= IXGBE_QV_STATE_POLL_YIELD;
457 		rc = false;
458 #ifdef BP_EXTENDED_STATS
459 		q_vector->rx.ring->stats.yields++;
460 #endif
461 	} else
462 		/* preserve yield marks */
463 		q_vector->state |= IXGBE_QV_STATE_POLL;
464 	spin_unlock_bh(&q_vector->lock);
465 	return rc;
466 }
467 
468 /* returns true if someone tried to get the qv while it was locked */
469 static inline bool ixgbe_qv_unlock_poll(struct ixgbe_q_vector *q_vector)
470 {
471 	int rc = false;
472 	spin_lock_bh(&q_vector->lock);
473 	WARN_ON(q_vector->state & (IXGBE_QV_STATE_NAPI));
474 
475 	if (q_vector->state & IXGBE_QV_STATE_POLL_YIELD)
476 		rc = true;
477 	/* will reset state to idle, unless QV is disabled */
478 	q_vector->state &= IXGBE_QV_STATE_DISABLED;
479 	spin_unlock_bh(&q_vector->lock);
480 	return rc;
481 }
482 
483 /* true if a socket is polling, even if it did not get the lock */
484 static inline bool ixgbe_qv_busy_polling(struct ixgbe_q_vector *q_vector)
485 {
486 	WARN_ON(!(q_vector->state & IXGBE_QV_OWNED));
487 	return q_vector->state & IXGBE_QV_USER_PEND;
488 }
489 
490 /* false if QV is currently owned */
491 static inline bool ixgbe_qv_disable(struct ixgbe_q_vector *q_vector)
492 {
493 	int rc = true;
494 	spin_lock_bh(&q_vector->lock);
495 	if (q_vector->state & IXGBE_QV_OWNED)
496 		rc = false;
497 	q_vector->state |= IXGBE_QV_STATE_DISABLED;
498 	spin_unlock_bh(&q_vector->lock);
499 
500 	return rc;
501 }
502 
503 #else /* CONFIG_NET_RX_BUSY_POLL */
504 static inline void ixgbe_qv_init_lock(struct ixgbe_q_vector *q_vector)
505 {
506 }
507 
508 static inline bool ixgbe_qv_lock_napi(struct ixgbe_q_vector *q_vector)
509 {
510 	return true;
511 }
512 
513 static inline bool ixgbe_qv_unlock_napi(struct ixgbe_q_vector *q_vector)
514 {
515 	return false;
516 }
517 
518 static inline bool ixgbe_qv_lock_poll(struct ixgbe_q_vector *q_vector)
519 {
520 	return false;
521 }
522 
523 static inline bool ixgbe_qv_unlock_poll(struct ixgbe_q_vector *q_vector)
524 {
525 	return false;
526 }
527 
528 static inline bool ixgbe_qv_busy_polling(struct ixgbe_q_vector *q_vector)
529 {
530 	return false;
531 }
532 
533 static inline bool ixgbe_qv_disable(struct ixgbe_q_vector *q_vector)
534 {
535 	return true;
536 }
537 
538 #endif /* CONFIG_NET_RX_BUSY_POLL */
539 
540 #ifdef CONFIG_IXGBE_HWMON
541 
542 #define IXGBE_HWMON_TYPE_LOC		0
543 #define IXGBE_HWMON_TYPE_TEMP		1
544 #define IXGBE_HWMON_TYPE_CAUTION	2
545 #define IXGBE_HWMON_TYPE_MAX		3
546 
547 struct hwmon_attr {
548 	struct device_attribute dev_attr;
549 	struct ixgbe_hw *hw;
550 	struct ixgbe_thermal_diode_data *sensor;
551 	char name[12];
552 };
553 
554 struct hwmon_buff {
555 	struct device *device;
556 	struct hwmon_attr *hwmon_list;
557 	unsigned int n_hwmon;
558 };
559 #endif /* CONFIG_IXGBE_HWMON */
560 
561 /*
562  * microsecond values for various ITR rates shifted by 2 to fit itr register
563  * with the first 3 bits reserved 0
564  */
565 #define IXGBE_MIN_RSC_ITR	24
566 #define IXGBE_100K_ITR		40
567 #define IXGBE_20K_ITR		200
568 #define IXGBE_10K_ITR		400
569 #define IXGBE_8K_ITR		500
570 
571 /* ixgbe_test_staterr - tests bits in Rx descriptor status and error fields */
572 static inline __le32 ixgbe_test_staterr(union ixgbe_adv_rx_desc *rx_desc,
573 					const u32 stat_err_bits)
574 {
575 	return rx_desc->wb.upper.status_error & cpu_to_le32(stat_err_bits);
576 }
577 
578 static inline u16 ixgbe_desc_unused(struct ixgbe_ring *ring)
579 {
580 	u16 ntc = ring->next_to_clean;
581 	u16 ntu = ring->next_to_use;
582 
583 	return ((ntc > ntu) ? 0 : ring->count) + ntc - ntu - 1;
584 }
585 
586 #define IXGBE_RX_DESC(R, i)	    \
587 	(&(((union ixgbe_adv_rx_desc *)((R)->desc))[i]))
588 #define IXGBE_TX_DESC(R, i)	    \
589 	(&(((union ixgbe_adv_tx_desc *)((R)->desc))[i]))
590 #define IXGBE_TX_CTXTDESC(R, i)	    \
591 	(&(((struct ixgbe_adv_tx_context_desc *)((R)->desc))[i]))
592 
593 #define IXGBE_MAX_JUMBO_FRAME_SIZE	9728 /* Maximum Supported Size 9.5KB */
594 #ifdef IXGBE_FCOE
595 /* Use 3K as the baby jumbo frame size for FCoE */
596 #define IXGBE_FCOE_JUMBO_FRAME_SIZE       3072
597 #endif /* IXGBE_FCOE */
598 
599 #define OTHER_VECTOR 1
600 #define NON_Q_VECTORS (OTHER_VECTOR)
601 
602 #define MAX_MSIX_VECTORS_82599 64
603 #define MAX_Q_VECTORS_82599 64
604 #define MAX_MSIX_VECTORS_82598 18
605 #define MAX_Q_VECTORS_82598 16
606 
607 #define MAX_Q_VECTORS MAX_Q_VECTORS_82599
608 #define MAX_MSIX_COUNT MAX_MSIX_VECTORS_82599
609 
610 #define MIN_MSIX_Q_VECTORS 1
611 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NON_Q_VECTORS)
612 
613 /* default to trying for four seconds */
614 #define IXGBE_TRY_LINK_TIMEOUT (4 * HZ)
615 
616 /* board specific private data structure */
617 struct ixgbe_adapter {
618 	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
619 	/* OS defined structs */
620 	struct net_device *netdev;
621 	struct pci_dev *pdev;
622 
623 	unsigned long state;
624 
625 	/* Some features need tri-state capability,
626 	 * thus the additional *_CAPABLE flags.
627 	 */
628 	u32 flags;
629 #define IXGBE_FLAG_MSI_CAPABLE                  (u32)(1 << 0)
630 #define IXGBE_FLAG_MSI_ENABLED                  (u32)(1 << 1)
631 #define IXGBE_FLAG_MSIX_CAPABLE                 (u32)(1 << 2)
632 #define IXGBE_FLAG_MSIX_ENABLED                 (u32)(1 << 3)
633 #define IXGBE_FLAG_RX_1BUF_CAPABLE              (u32)(1 << 4)
634 #define IXGBE_FLAG_RX_PS_CAPABLE                (u32)(1 << 5)
635 #define IXGBE_FLAG_RX_PS_ENABLED                (u32)(1 << 6)
636 #define IXGBE_FLAG_IN_NETPOLL                   (u32)(1 << 7)
637 #define IXGBE_FLAG_DCA_ENABLED                  (u32)(1 << 8)
638 #define IXGBE_FLAG_DCA_CAPABLE                  (u32)(1 << 9)
639 #define IXGBE_FLAG_IMIR_ENABLED                 (u32)(1 << 10)
640 #define IXGBE_FLAG_MQ_CAPABLE                   (u32)(1 << 11)
641 #define IXGBE_FLAG_DCB_ENABLED                  (u32)(1 << 12)
642 #define IXGBE_FLAG_VMDQ_CAPABLE                 (u32)(1 << 13)
643 #define IXGBE_FLAG_VMDQ_ENABLED                 (u32)(1 << 14)
644 #define IXGBE_FLAG_FAN_FAIL_CAPABLE             (u32)(1 << 15)
645 #define IXGBE_FLAG_NEED_LINK_UPDATE             (u32)(1 << 16)
646 #define IXGBE_FLAG_NEED_LINK_CONFIG             (u32)(1 << 17)
647 #define IXGBE_FLAG_FDIR_HASH_CAPABLE            (u32)(1 << 18)
648 #define IXGBE_FLAG_FDIR_PERFECT_CAPABLE         (u32)(1 << 19)
649 #define IXGBE_FLAG_FCOE_CAPABLE                 (u32)(1 << 20)
650 #define IXGBE_FLAG_FCOE_ENABLED                 (u32)(1 << 21)
651 #define IXGBE_FLAG_SRIOV_CAPABLE                (u32)(1 << 22)
652 #define IXGBE_FLAG_SRIOV_ENABLED                (u32)(1 << 23)
653 
654 	u32 flags2;
655 #define IXGBE_FLAG2_RSC_CAPABLE                 (u32)(1 << 0)
656 #define IXGBE_FLAG2_RSC_ENABLED                 (u32)(1 << 1)
657 #define IXGBE_FLAG2_TEMP_SENSOR_CAPABLE         (u32)(1 << 2)
658 #define IXGBE_FLAG2_TEMP_SENSOR_EVENT           (u32)(1 << 3)
659 #define IXGBE_FLAG2_SEARCH_FOR_SFP              (u32)(1 << 4)
660 #define IXGBE_FLAG2_SFP_NEEDS_RESET             (u32)(1 << 5)
661 #define IXGBE_FLAG2_RESET_REQUESTED             (u32)(1 << 6)
662 #define IXGBE_FLAG2_FDIR_REQUIRES_REINIT        (u32)(1 << 7)
663 #define IXGBE_FLAG2_RSS_FIELD_IPV4_UDP		(u32)(1 << 8)
664 #define IXGBE_FLAG2_RSS_FIELD_IPV6_UDP		(u32)(1 << 9)
665 #define IXGBE_FLAG2_PTP_PPS_ENABLED		(u32)(1 << 10)
666 #define IXGBE_FLAG2_BRIDGE_MODE_VEB		(u32)(1 << 11)
667 
668 	/* Tx fast path data */
669 	int num_tx_queues;
670 	u16 tx_itr_setting;
671 	u16 tx_work_limit;
672 
673 	/* Rx fast path data */
674 	int num_rx_queues;
675 	u16 rx_itr_setting;
676 
677 	/* TX */
678 	struct ixgbe_ring *tx_ring[MAX_TX_QUEUES] ____cacheline_aligned_in_smp;
679 
680 	u64 restart_queue;
681 	u64 lsc_int;
682 	u32 tx_timeout_count;
683 
684 	/* RX */
685 	struct ixgbe_ring *rx_ring[MAX_RX_QUEUES];
686 	int num_rx_pools;		/* == num_rx_queues in 82598 */
687 	int num_rx_queues_per_pool;	/* 1 if 82598, can be many if 82599 */
688 	u64 hw_csum_rx_error;
689 	u64 hw_rx_no_dma_resources;
690 	u64 rsc_total_count;
691 	u64 rsc_total_flush;
692 	u64 non_eop_descs;
693 	u32 alloc_rx_page_failed;
694 	u32 alloc_rx_buff_failed;
695 
696 	struct ixgbe_q_vector *q_vector[MAX_Q_VECTORS];
697 
698 	/* DCB parameters */
699 	struct ieee_pfc *ixgbe_ieee_pfc;
700 	struct ieee_ets *ixgbe_ieee_ets;
701 	struct ixgbe_dcb_config dcb_cfg;
702 	struct ixgbe_dcb_config temp_dcb_cfg;
703 	u8 dcb_set_bitmap;
704 	u8 dcbx_cap;
705 	enum ixgbe_fc_mode last_lfc_mode;
706 
707 	int num_q_vectors;	/* current number of q_vectors for device */
708 	int max_q_vectors;	/* true count of q_vectors for device */
709 	struct ixgbe_ring_feature ring_feature[RING_F_ARRAY_SIZE];
710 	struct msix_entry *msix_entries;
711 
712 	u32 test_icr;
713 	struct ixgbe_ring test_tx_ring;
714 	struct ixgbe_ring test_rx_ring;
715 
716 	/* structs defined in ixgbe_hw.h */
717 	struct ixgbe_hw hw;
718 	u16 msg_enable;
719 	struct ixgbe_hw_stats stats;
720 
721 	u64 tx_busy;
722 	unsigned int tx_ring_count;
723 	unsigned int rx_ring_count;
724 
725 	u32 link_speed;
726 	bool link_up;
727 	unsigned long link_check_timeout;
728 
729 	struct timer_list service_timer;
730 	struct work_struct service_task;
731 
732 	struct hlist_head fdir_filter_list;
733 	unsigned long fdir_overflow; /* number of times ATR was backed off */
734 	union ixgbe_atr_input fdir_mask;
735 	int fdir_filter_count;
736 	u32 fdir_pballoc;
737 	u32 atr_sample_rate;
738 	spinlock_t fdir_perfect_lock;
739 
740 #ifdef IXGBE_FCOE
741 	struct ixgbe_fcoe fcoe;
742 #endif /* IXGBE_FCOE */
743 	u32 wol;
744 
745 	u16 bd_number;
746 
747 	u16 eeprom_verh;
748 	u16 eeprom_verl;
749 	u16 eeprom_cap;
750 
751 	u32 interrupt_event;
752 	u32 led_reg;
753 
754 	struct ptp_clock *ptp_clock;
755 	struct ptp_clock_info ptp_caps;
756 	struct work_struct ptp_tx_work;
757 	struct sk_buff *ptp_tx_skb;
758 	unsigned long ptp_tx_start;
759 	unsigned long last_overflow_check;
760 	unsigned long last_rx_ptp_check;
761 	spinlock_t tmreg_lock;
762 	struct cyclecounter cc;
763 	struct timecounter tc;
764 	u32 base_incval;
765 
766 	/* SR-IOV */
767 	DECLARE_BITMAP(active_vfs, IXGBE_MAX_VF_FUNCTIONS);
768 	unsigned int num_vfs;
769 	struct vf_data_storage *vfinfo;
770 	int vf_rate_link_speed;
771 	struct vf_macvlans vf_mvs;
772 	struct vf_macvlans *mv_list;
773 
774 	u32 timer_event_accumulator;
775 	u32 vferr_refcount;
776 	struct kobject *info_kobj;
777 #ifdef CONFIG_IXGBE_HWMON
778 	struct hwmon_buff ixgbe_hwmon_buff;
779 #endif /* CONFIG_IXGBE_HWMON */
780 #ifdef CONFIG_DEBUG_FS
781 	struct dentry *ixgbe_dbg_adapter;
782 #endif /*CONFIG_DEBUG_FS*/
783 
784 	u8 default_up;
785 	unsigned long fwd_bitmask; /* Bitmask indicating in use pools */
786 };
787 
788 struct ixgbe_fdir_filter {
789 	struct hlist_node fdir_node;
790 	union ixgbe_atr_input filter;
791 	u16 sw_idx;
792 	u16 action;
793 };
794 
795 enum ixgbe_state_t {
796 	__IXGBE_TESTING,
797 	__IXGBE_RESETTING,
798 	__IXGBE_DOWN,
799 	__IXGBE_SERVICE_SCHED,
800 	__IXGBE_IN_SFP_INIT,
801 	__IXGBE_PTP_RUNNING,
802 };
803 
804 struct ixgbe_cb {
805 	union {				/* Union defining head/tail partner */
806 		struct sk_buff *head;
807 		struct sk_buff *tail;
808 	};
809 	dma_addr_t dma;
810 	u16 append_cnt;
811 	bool page_released;
812 };
813 #define IXGBE_CB(skb) ((struct ixgbe_cb *)(skb)->cb)
814 
815 enum ixgbe_boards {
816 	board_82598,
817 	board_82599,
818 	board_X540,
819 };
820 
821 extern struct ixgbe_info ixgbe_82598_info;
822 extern struct ixgbe_info ixgbe_82599_info;
823 extern struct ixgbe_info ixgbe_X540_info;
824 #ifdef CONFIG_IXGBE_DCB
825 extern const struct dcbnl_rtnl_ops dcbnl_ops;
826 #endif
827 
828 extern char ixgbe_driver_name[];
829 extern const char ixgbe_driver_version[];
830 #ifdef IXGBE_FCOE
831 extern char ixgbe_default_device_descr[];
832 #endif /* IXGBE_FCOE */
833 
834 void ixgbe_up(struct ixgbe_adapter *adapter);
835 void ixgbe_down(struct ixgbe_adapter *adapter);
836 void ixgbe_reinit_locked(struct ixgbe_adapter *adapter);
837 void ixgbe_reset(struct ixgbe_adapter *adapter);
838 void ixgbe_set_ethtool_ops(struct net_device *netdev);
839 int ixgbe_setup_rx_resources(struct ixgbe_ring *);
840 int ixgbe_setup_tx_resources(struct ixgbe_ring *);
841 void ixgbe_free_rx_resources(struct ixgbe_ring *);
842 void ixgbe_free_tx_resources(struct ixgbe_ring *);
843 void ixgbe_configure_rx_ring(struct ixgbe_adapter *, struct ixgbe_ring *);
844 void ixgbe_configure_tx_ring(struct ixgbe_adapter *, struct ixgbe_ring *);
845 void ixgbe_disable_rx_queue(struct ixgbe_adapter *adapter, struct ixgbe_ring *);
846 void ixgbe_update_stats(struct ixgbe_adapter *adapter);
847 int ixgbe_init_interrupt_scheme(struct ixgbe_adapter *adapter);
848 int ixgbe_wol_supported(struct ixgbe_adapter *adapter, u16 device_id,
849 			       u16 subdevice_id);
850 void ixgbe_clear_interrupt_scheme(struct ixgbe_adapter *adapter);
851 netdev_tx_t ixgbe_xmit_frame_ring(struct sk_buff *, struct ixgbe_adapter *,
852 				  struct ixgbe_ring *);
853 void ixgbe_unmap_and_free_tx_resource(struct ixgbe_ring *,
854 				      struct ixgbe_tx_buffer *);
855 void ixgbe_alloc_rx_buffers(struct ixgbe_ring *, u16);
856 void ixgbe_write_eitr(struct ixgbe_q_vector *);
857 int ixgbe_poll(struct napi_struct *napi, int budget);
858 int ethtool_ioctl(struct ifreq *ifr);
859 s32 ixgbe_reinit_fdir_tables_82599(struct ixgbe_hw *hw);
860 s32 ixgbe_init_fdir_signature_82599(struct ixgbe_hw *hw, u32 fdirctrl);
861 s32 ixgbe_init_fdir_perfect_82599(struct ixgbe_hw *hw, u32 fdirctrl);
862 s32 ixgbe_fdir_add_signature_filter_82599(struct ixgbe_hw *hw,
863 					  union ixgbe_atr_hash_dword input,
864 					  union ixgbe_atr_hash_dword common,
865 					  u8 queue);
866 s32 ixgbe_fdir_set_input_mask_82599(struct ixgbe_hw *hw,
867 				    union ixgbe_atr_input *input_mask);
868 s32 ixgbe_fdir_write_perfect_filter_82599(struct ixgbe_hw *hw,
869 					  union ixgbe_atr_input *input,
870 					  u16 soft_id, u8 queue);
871 s32 ixgbe_fdir_erase_perfect_filter_82599(struct ixgbe_hw *hw,
872 					  union ixgbe_atr_input *input,
873 					  u16 soft_id);
874 void ixgbe_atr_compute_perfect_hash_82599(union ixgbe_atr_input *input,
875 					  union ixgbe_atr_input *mask);
876 bool ixgbe_verify_lesm_fw_enabled_82599(struct ixgbe_hw *hw);
877 void ixgbe_set_rx_mode(struct net_device *netdev);
878 #ifdef CONFIG_IXGBE_DCB
879 void ixgbe_set_rx_drop_en(struct ixgbe_adapter *adapter);
880 #endif
881 int ixgbe_setup_tc(struct net_device *dev, u8 tc);
882 void ixgbe_tx_ctxtdesc(struct ixgbe_ring *, u32, u32, u32, u32);
883 void ixgbe_do_reset(struct net_device *netdev);
884 #ifdef CONFIG_IXGBE_HWMON
885 void ixgbe_sysfs_exit(struct ixgbe_adapter *adapter);
886 int ixgbe_sysfs_init(struct ixgbe_adapter *adapter);
887 #endif /* CONFIG_IXGBE_HWMON */
888 #ifdef IXGBE_FCOE
889 void ixgbe_configure_fcoe(struct ixgbe_adapter *adapter);
890 int ixgbe_fso(struct ixgbe_ring *tx_ring, struct ixgbe_tx_buffer *first,
891 	      u8 *hdr_len);
892 int ixgbe_fcoe_ddp(struct ixgbe_adapter *adapter,
893 		   union ixgbe_adv_rx_desc *rx_desc, struct sk_buff *skb);
894 int ixgbe_fcoe_ddp_get(struct net_device *netdev, u16 xid,
895 		       struct scatterlist *sgl, unsigned int sgc);
896 int ixgbe_fcoe_ddp_target(struct net_device *netdev, u16 xid,
897 			  struct scatterlist *sgl, unsigned int sgc);
898 int ixgbe_fcoe_ddp_put(struct net_device *netdev, u16 xid);
899 int ixgbe_setup_fcoe_ddp_resources(struct ixgbe_adapter *adapter);
900 void ixgbe_free_fcoe_ddp_resources(struct ixgbe_adapter *adapter);
901 int ixgbe_fcoe_enable(struct net_device *netdev);
902 int ixgbe_fcoe_disable(struct net_device *netdev);
903 #ifdef CONFIG_IXGBE_DCB
904 u8 ixgbe_fcoe_getapp(struct ixgbe_adapter *adapter);
905 u8 ixgbe_fcoe_setapp(struct ixgbe_adapter *adapter, u8 up);
906 #endif /* CONFIG_IXGBE_DCB */
907 int ixgbe_fcoe_get_wwn(struct net_device *netdev, u64 *wwn, int type);
908 int ixgbe_fcoe_get_hbainfo(struct net_device *netdev,
909 			   struct netdev_fcoe_hbainfo *info);
910 u8 ixgbe_fcoe_get_tc(struct ixgbe_adapter *adapter);
911 #endif /* IXGBE_FCOE */
912 #ifdef CONFIG_DEBUG_FS
913 void ixgbe_dbg_adapter_init(struct ixgbe_adapter *adapter);
914 void ixgbe_dbg_adapter_exit(struct ixgbe_adapter *adapter);
915 void ixgbe_dbg_init(void);
916 void ixgbe_dbg_exit(void);
917 #else
918 static inline void ixgbe_dbg_adapter_init(struct ixgbe_adapter *adapter) {}
919 static inline void ixgbe_dbg_adapter_exit(struct ixgbe_adapter *adapter) {}
920 static inline void ixgbe_dbg_init(void) {}
921 static inline void ixgbe_dbg_exit(void) {}
922 #endif /* CONFIG_DEBUG_FS */
923 static inline struct netdev_queue *txring_txq(const struct ixgbe_ring *ring)
924 {
925 	return netdev_get_tx_queue(ring->netdev, ring->queue_index);
926 }
927 
928 void ixgbe_ptp_init(struct ixgbe_adapter *adapter);
929 void ixgbe_ptp_stop(struct ixgbe_adapter *adapter);
930 void ixgbe_ptp_overflow_check(struct ixgbe_adapter *adapter);
931 void ixgbe_ptp_rx_hang(struct ixgbe_adapter *adapter);
932 void __ixgbe_ptp_rx_hwtstamp(struct ixgbe_q_vector *q_vector,
933 			     struct sk_buff *skb);
934 static inline void ixgbe_ptp_rx_hwtstamp(struct ixgbe_ring *rx_ring,
935 					 union ixgbe_adv_rx_desc *rx_desc,
936 					 struct sk_buff *skb)
937 {
938 	if (unlikely(!ixgbe_test_staterr(rx_desc, IXGBE_RXDADV_STAT_TS)))
939 		return;
940 
941 	__ixgbe_ptp_rx_hwtstamp(rx_ring->q_vector, skb);
942 
943 	/*
944 	 * Update the last_rx_timestamp timer in order to enable watchdog check
945 	 * for error case of latched timestamp on a dropped packet.
946 	 */
947 	rx_ring->last_rx_timestamp = jiffies;
948 }
949 
950 int ixgbe_ptp_hwtstamp_ioctl(struct ixgbe_adapter *adapter, struct ifreq *ifr,
951 			     int cmd);
952 void ixgbe_ptp_start_cyclecounter(struct ixgbe_adapter *adapter);
953 void ixgbe_ptp_reset(struct ixgbe_adapter *adapter);
954 void ixgbe_ptp_check_pps_event(struct ixgbe_adapter *adapter, u32 eicr);
955 #ifdef CONFIG_PCI_IOV
956 void ixgbe_sriov_reinit(struct ixgbe_adapter *adapter);
957 #endif
958 
959 netdev_tx_t ixgbe_xmit_frame_ring(struct sk_buff *skb,
960 				  struct ixgbe_adapter *adapter,
961 				  struct ixgbe_ring *tx_ring);
962 #endif /* _IXGBE_H_ */
963