[deliverable/linux.git] / drivers / net / ethernet / intel / i40e / i40e_txrx.h

/*******************************************************************************
 *
 * Intel Ethernet Controller XL710 Family Linux Driver
 * Copyright(c) 2013 - 2014 Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * The full GNU General Public License is included in this distribution in
 * the file called "COPYING".
 *
 * Contact Information:
 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 ******************************************************************************/

#ifndef _I40E_TXRX_H_
#define _I40E_TXRX_H_

/* Interrupt Throttling and Rate Limiting Goodies */

#define I40E_MAX_ITR               0x0FF0  /* reg uses 2 usec resolution */
#define I40E_MIN_ITR               0x0001  /* reg uses 2 usec resolution */
#define I40E_ITR_100K              0x0005
#define I40E_ITR_20K               0x0019
#define I40E_ITR_8K                0x003E
#define I40E_ITR_4K                0x007A
#define I40E_ITR_RX_DEF            I40E_ITR_8K
#define I40E_ITR_TX_DEF            I40E_ITR_4K
#define I40E_ITR_DYNAMIC           0x8000  /* use top bit as a flag */
#define I40E_MIN_INT_RATE          250     /* ~= 1000000 / (I40E_MAX_ITR * 2) */
#define I40E_MAX_INT_RATE          500000  /* == 1000000 / (I40E_MIN_ITR * 2) */
#define I40E_DEFAULT_IRQ_WORK      256
#define ITR_TO_REG(setting) ((setting & ~I40E_ITR_DYNAMIC) >> 1)
#define ITR_IS_DYNAMIC(setting) (!!(setting & I40E_ITR_DYNAMIC))
#define ITR_REG_TO_USEC(itr_reg) (itr_reg << 1)

#define I40E_QUEUE_END_OF_LIST 0x7FF

/* this enum matches hardware bits and is meant to be used by DYN_CTLN
 * registers and QINT registers or more generally anywhere in the manual
 * mentioning ITR_INDX, ITR_NONE cannot be used as an index 'n' into any
 * register but instead is a special value meaning "don't update" ITR0/1/2.
 */
enum i40e_dyn_idx_t {
	I40E_IDX_ITR0 = 0,
	I40E_IDX_ITR1 = 1,
	I40E_IDX_ITR2 = 2,
	I40E_ITR_NONE = 3	/* ITR_NONE must not be used as an index */
};

/* these are indexes into ITRN registers */
#define I40E_RX_ITR    I40E_IDX_ITR0
#define I40E_TX_ITR    I40E_IDX_ITR1
#define I40E_PE_ITR    I40E_IDX_ITR2

/* Supported RSS offloads */
#define I40E_DEFAULT_RSS_HENA ( \
	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV4_UDP) | \
	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV4_SCTP) | \
	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV4_TCP) | \
	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV4_OTHER) | \
	((u64)1 << I40E_FILTER_PCTYPE_FRAG_IPV4) | \
	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV6_UDP) | \
	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV6_TCP) | \
	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV6_SCTP) | \
	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV6_OTHER) | \
	((u64)1 << I40E_FILTER_PCTYPE_FRAG_IPV6) | \
	((u64)1 << I40E_FILTER_PCTYPE_L2_PAYLOAD))

/* Supported Rx Buffer Sizes */
#define I40E_RXBUFFER_512   512    /* Used for packet split */
#define I40E_RXBUFFER_2048  2048
#define I40E_RXBUFFER_3072  3072   /* For FCoE MTU of 2158 */
#define I40E_RXBUFFER_4096  4096
#define I40E_RXBUFFER_8192  8192
#define I40E_MAX_RXBUFFER   9728  /* largest size for single descriptor */

/* NOTE: netdev_alloc_skb reserves up to 64 bytes, NET_IP_ALIGN means we
 * reserve 2 more, and skb_shared_info adds an additional 384 bytes more,
 * this adds up to 512 bytes of extra data meaning the smallest allocation
 * we could have is 1K.
 * i.e. RXBUFFER_512 --> size-1024 slab
 */
#define I40E_RX_HDR_SIZE  I40E_RXBUFFER_512

/* How many Rx Buffers do we bundle into one write to the hardware ? */
#define I40E_RX_BUFFER_WRITE	16	/* Must be power of 2 */
#define I40E_RX_NEXT_DESC(r, i, n)		\
	do {					\
		(i)++;				\
		if ((i) == (r)->count)		\
			i = 0;			\
		(n) = I40E_RX_DESC((r), (i));	\
	} while (0)

#define I40E_RX_NEXT_DESC_PREFETCH(r, i, n)		\
	do {						\
		I40E_RX_NEXT_DESC((r), (i), (n));	\
		prefetch((n));				\
	} while (0)

#define i40e_rx_desc i40e_32byte_rx_desc

#define I40E_MAX_BUFFER_TXD	8
#define I40E_MIN_TX_LEN		17
#define I40E_MAX_DATA_PER_TXD	8192

/* Tx Descriptors needed, worst case */
#define TXD_USE_COUNT(S) DIV_ROUND_UP((S), I40E_MAX_DATA_PER_TXD)
#define DESC_NEEDED (MAX_SKB_FRAGS + 4)
#define I40E_MIN_DESC_PENDING	4

#define I40E_TX_FLAGS_CSUM		(u32)(1)
#define I40E_TX_FLAGS_HW_VLAN		(u32)(1 << 1)
#define I40E_TX_FLAGS_SW_VLAN		(u32)(1 << 2)
#define I40E_TX_FLAGS_TSO		(u32)(1 << 3)
#define I40E_TX_FLAGS_IPV4		(u32)(1 << 4)
#define I40E_TX_FLAGS_IPV6		(u32)(1 << 5)
#define I40E_TX_FLAGS_FCCRC		(u32)(1 << 6)
#define I40E_TX_FLAGS_FSO		(u32)(1 << 7)
#define I40E_TX_FLAGS_TSYN		(u32)(1 << 8)
#define I40E_TX_FLAGS_FD_SB		(u32)(1 << 9)
#define I40E_TX_FLAGS_VLAN_MASK		0xffff0000
#define I40E_TX_FLAGS_VLAN_PRIO_MASK	0xe0000000
#define I40E_TX_FLAGS_VLAN_PRIO_SHIFT	29
#define I40E_TX_FLAGS_VLAN_SHIFT	16

struct i40e_tx_buffer {
	struct i40e_tx_desc *next_to_watch;
	unsigned long time_stamp;
	union {
		struct sk_buff *skb;
		void *raw_buf;
	};
	unsigned int bytecount;
	unsigned short gso_segs;
	DEFINE_DMA_UNMAP_ADDR(dma);
	DEFINE_DMA_UNMAP_LEN(len);
	u32 tx_flags;
};

struct i40e_rx_buffer {
	struct sk_buff *skb;
	dma_addr_t dma;
	struct page *page;
	dma_addr_t page_dma;
	unsigned int page_offset;
};

struct i40e_queue_stats {
	u64 packets;
	u64 bytes;
};

struct i40e_tx_queue_stats {
	u64 restart_queue;
	u64 tx_busy;
	u64 tx_done_old;
};

struct i40e_rx_queue_stats {
	u64 non_eop_descs;
	u64 alloc_page_failed;
	u64 alloc_buff_failed;
};

enum i40e_ring_state_t {
	__I40E_TX_FDIR_INIT_DONE,
	__I40E_TX_XPS_INIT_DONE,
	__I40E_TX_DETECT_HANG,
	__I40E_HANG_CHECK_ARMED,
	__I40E_RX_PS_ENABLED,
	__I40E_RX_16BYTE_DESC_ENABLED,
};

#define ring_is_ps_enabled(ring) \
	test_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
#define set_ring_ps_enabled(ring) \
	set_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
#define clear_ring_ps_enabled(ring) \
	clear_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
#define check_for_tx_hang(ring) \
	test_bit(__I40E_TX_DETECT_HANG, &(ring)->state)
#define set_check_for_tx_hang(ring) \
	set_bit(__I40E_TX_DETECT_HANG, &(ring)->state)
#define clear_check_for_tx_hang(ring) \
	clear_bit(__I40E_TX_DETECT_HANG, &(ring)->state)
#define ring_is_16byte_desc_enabled(ring) \
	test_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
#define set_ring_16byte_desc_enabled(ring) \
	set_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
#define clear_ring_16byte_desc_enabled(ring) \
	clear_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)

/* struct that defines a descriptor ring, associated with a VSI */
struct i40e_ring {
	struct i40e_ring *next;		/* pointer to next ring in q_vector */
	void *desc;			/* Descriptor ring memory */
	struct device *dev;		/* Used for DMA mapping */
	struct net_device *netdev;	/* netdev ring maps to */
	union {
		struct i40e_tx_buffer *tx_bi;
		struct i40e_rx_buffer *rx_bi;
	};
	unsigned long state;
	u16 queue_index;		/* Queue number of ring */
	u8 dcb_tc;			/* Traffic class of ring */
	u8 __iomem *tail;

	u16 count;			/* Number of descriptors */
	u16 reg_idx;			/* HW register index of the ring */
	u16 rx_hdr_len;
	u16 rx_buf_len;
	u8  dtype;
#define I40E_RX_DTYPE_NO_SPLIT      0
#define I40E_RX_DTYPE_SPLIT_ALWAYS  1
#define I40E_RX_DTYPE_HEADER_SPLIT  2
	u8  hsplit;
#define I40E_RX_SPLIT_L2      0x1
#define I40E_RX_SPLIT_IP      0x2
#define I40E_RX_SPLIT_TCP_UDP 0x4
#define I40E_RX_SPLIT_SCTP    0x8

	/* used in interrupt processing */
	u16 next_to_use;
	u16 next_to_clean;

	u8 atr_sample_rate;
	u8 atr_count;

	unsigned long last_rx_timestamp;

	bool ring_active;		/* is ring online or not */
	bool arm_wb;		/* do something to arm write back */

	/* stats structs */
	struct i40e_queue_stats	stats;
	struct u64_stats_sync syncp;
	union {
		struct i40e_tx_queue_stats tx_stats;
		struct i40e_rx_queue_stats rx_stats;
	};

	unsigned int size;		/* length of descriptor ring in bytes */
	dma_addr_t dma;			/* physical address of ring */

	struct i40e_vsi *vsi;		/* Backreference to associated VSI */
	struct i40e_q_vector *q_vector;	/* Backreference to associated vector */

	struct rcu_head rcu;		/* to avoid race on free */
} ____cacheline_internodealigned_in_smp;

enum i40e_latency_range {
	I40E_LOWEST_LATENCY = 0,
	I40E_LOW_LATENCY = 1,
	I40E_BULK_LATENCY = 2,
};

struct i40e_ring_container {
	/* array of pointers to rings */
	struct i40e_ring *ring;
	unsigned int total_bytes;	/* total bytes processed this int */
	unsigned int total_packets;	/* total packets processed this int */
	u16 count;
	enum i40e_latency_range latency_range;
	u16 itr;
};

/* iterator for handling rings in ring container */
#define i40e_for_each_ring(pos, head) \
	for (pos = (head).ring; pos != NULL; pos = pos->next)

void i40e_alloc_rx_buffers(struct i40e_ring *rxr, u16 cleaned_count);
netdev_tx_t i40e_lan_xmit_frame(struct sk_buff *skb, struct net_device *netdev);
void i40e_clean_tx_ring(struct i40e_ring *tx_ring);
void i40e_clean_rx_ring(struct i40e_ring *rx_ring);
int i40e_setup_tx_descriptors(struct i40e_ring *tx_ring);
int i40e_setup_rx_descriptors(struct i40e_ring *rx_ring);
void i40e_free_tx_resources(struct i40e_ring *tx_ring);
void i40e_free_rx_resources(struct i40e_ring *rx_ring);
int i40e_napi_poll(struct napi_struct *napi, int budget);
#ifdef I40E_FCOE
void i40e_tx_map(struct i40e_ring *tx_ring, struct sk_buff *skb,
		 struct i40e_tx_buffer *first, u32 tx_flags,
		 const u8 hdr_len, u32 td_cmd, u32 td_offset);
int i40e_maybe_stop_tx(struct i40e_ring *tx_ring, int size);
int i40e_xmit_descriptor_count(struct sk_buff *skb, struct i40e_ring *tx_ring);
int i40e_tx_prepare_vlan_flags(struct sk_buff *skb,
			       struct i40e_ring *tx_ring, u32 *flags);
#endif
#endif /* _I40E_TXRX_H_ */
Commit	Line	Data
7daa6bf3 JB	1	/*******************************************************************************
	2	*
	3	* Intel Ethernet Controller XL710 Family Linux Driver
dc641b73	4	* Copyright(c) 2013 - 2014 Intel Corporation.
7daa6bf3 JB	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	*
dc641b73 GR	15	* You should have received a copy of the GNU General Public License along
dc641b73 GR	16	* with this program. If not, see <http://www.gnu.org/licenses/>.
7daa6bf3 JB	17	*
	18	* The full GNU General Public License is included in this distribution in
	19	* the file called "COPYING".
	20	*
	21	* Contact Information:
	22	* e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
	23	* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
	24	*
	25	******************************************************************************/
	26
36fac581 VD	27	#ifndef _I40E_TXRX_H_
	28	#define _I40E_TXRX_H_
	29
aee8087f	30	/* Interrupt Throttling and Rate Limiting Goodies */
7daa6bf3	31
3126dcb7	32	#define I40E_MAX_ITR 0x0FF0 /* reg uses 2 usec resolution */
79442d38	33	#define I40E_MIN_ITR 0x0001 /* reg uses 2 usec resolution */
7daa6bf3 JB	34	#define I40E_ITR_100K 0x0005
	35	#define I40E_ITR_20K 0x0019
	36	#define I40E_ITR_8K 0x003E
	37	#define I40E_ITR_4K 0x007A
	38	#define I40E_ITR_RX_DEF I40E_ITR_8K
	39	#define I40E_ITR_TX_DEF I40E_ITR_4K
	40	#define I40E_ITR_DYNAMIC 0x8000 /* use top bit as a flag */
	41	#define I40E_MIN_INT_RATE 250 /* ~= 1000000 / (I40E_MAX_ITR * 2) */
	42	#define I40E_MAX_INT_RATE 500000 /* == 1000000 / (I40E_MIN_ITR * 2) */
	43	#define I40E_DEFAULT_IRQ_WORK 256
	44	#define ITR_TO_REG(setting) ((setting & ~I40E_ITR_DYNAMIC) >> 1)
	45	#define ITR_IS_DYNAMIC(setting) (!!(setting & I40E_ITR_DYNAMIC))
	46	#define ITR_REG_TO_USEC(itr_reg) (itr_reg << 1)
	47
	48	#define I40E_QUEUE_END_OF_LIST 0x7FF
	49
0319577f JB	50	/* this enum matches hardware bits and is meant to be used by DYN_CTLN
	51	* registers and QINT registers or more generally anywhere in the manual
	52	* mentioning ITR_INDX, ITR_NONE cannot be used as an index 'n' into any
	53	* register but instead is a special value meaning "don't update" ITR0/1/2.
	54	*/
	55	enum i40e_dyn_idx_t {
	56	I40E_IDX_ITR0 = 0,
	57	I40E_IDX_ITR1 = 1,
	58	I40E_IDX_ITR2 = 2,
	59	I40E_ITR_NONE = 3 /* ITR_NONE must not be used as an index */
	60	};
	61
	62	/* these are indexes into ITRN registers */
	63	#define I40E_RX_ITR I40E_IDX_ITR0
	64	#define I40E_TX_ITR I40E_IDX_ITR1
	65	#define I40E_PE_ITR I40E_IDX_ITR2
	66
12dc4fe3 MW	67	/* Supported RSS offloads */
12dc4fe3 MW	68	#define I40E_DEFAULT_RSS_HENA ( \
12dc4fe3 MW	69	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV4_UDP) \| \
12dc4fe3 MW	70	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV4_SCTP) \| \
12dc4fe3 MW	71	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV4_TCP) \| \
	72	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV4_OTHER) \| \
	73	((u64)1 << I40E_FILTER_PCTYPE_FRAG_IPV4) \| \
12dc4fe3	74	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV6_UDP) \| \
12dc4fe3 MW	75	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV6_TCP) \| \
	76	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV6_SCTP) \| \
	77	((u64)1 << I40E_FILTER_PCTYPE_NONF_IPV6_OTHER) \| \
	78	((u64)1 << I40E_FILTER_PCTYPE_FRAG_IPV6) \| \
	79	((u64)1 << I40E_FILTER_PCTYPE_L2_PAYLOAD))
	80
7daa6bf3 JB	81	/* Supported Rx Buffer Sizes */
	82	#define I40E_RXBUFFER_512 512 /* Used for packet split */
	83	#define I40E_RXBUFFER_2048 2048
	84	#define I40E_RXBUFFER_3072 3072 /* For FCoE MTU of 2158 */
	85	#define I40E_RXBUFFER_4096 4096
	86	#define I40E_RXBUFFER_8192 8192
	87	#define I40E_MAX_RXBUFFER 9728 /* largest size for single descriptor */
	88
	89	/* NOTE: netdev_alloc_skb reserves up to 64 bytes, NET_IP_ALIGN means we
	90	* reserve 2 more, and skb_shared_info adds an additional 384 bytes more,
	91	* this adds up to 512 bytes of extra data meaning the smallest allocation
	92	* we could have is 1K.
	93	* i.e. RXBUFFER_512 --> size-1024 slab
	94	*/
	95	#define I40E_RX_HDR_SIZE I40E_RXBUFFER_512
	96
	97	/* How many Rx Buffers do we bundle into one write to the hardware ? */
	98	#define I40E_RX_BUFFER_WRITE 16 /* Must be power of 2 */
	99	#define I40E_RX_NEXT_DESC(r, i, n) \
	100	do { \
	101	(i)++; \
	102	if ((i) == (r)->count) \
	103	i = 0; \
	104	(n) = I40E_RX_DESC((r), (i)); \
	105	} while (0)
	106
	107	#define I40E_RX_NEXT_DESC_PREFETCH(r, i, n) \
	108	do { \
	109	I40E_RX_NEXT_DESC((r), (i), (n)); \
	110	prefetch((n)); \
	111	} while (0)
	112
	113	#define i40e_rx_desc i40e_32byte_rx_desc
	114
71da6197	115	#define I40E_MAX_BUFFER_TXD 8
7daa6bf3	116	#define I40E_MIN_TX_LEN 17
980093eb	117	#define I40E_MAX_DATA_PER_TXD 8192
7daa6bf3 JB	118
	119	/* Tx Descriptors needed, worst case */
	120	#define TXD_USE_COUNT(S) DIV_ROUND_UP((S), I40E_MAX_DATA_PER_TXD)
980093eb	121	#define DESC_NEEDED (MAX_SKB_FRAGS + 4)
810b3ae4	122	#define I40E_MIN_DESC_PENDING 4
7daa6bf3 JB	123
	124	#define I40E_TX_FLAGS_CSUM (u32)(1)
	125	#define I40E_TX_FLAGS_HW_VLAN (u32)(1 << 1)
	126	#define I40E_TX_FLAGS_SW_VLAN (u32)(1 << 2)
	127	#define I40E_TX_FLAGS_TSO (u32)(1 << 3)
	128	#define I40E_TX_FLAGS_IPV4 (u32)(1 << 4)
	129	#define I40E_TX_FLAGS_IPV6 (u32)(1 << 5)
	130	#define I40E_TX_FLAGS_FCCRC (u32)(1 << 6)
	131	#define I40E_TX_FLAGS_FSO (u32)(1 << 7)
beb0dff1	132	#define I40E_TX_FLAGS_TSYN (u32)(1 << 8)
49d7d933	133	#define I40E_TX_FLAGS_FD_SB (u32)(1 << 9)
7daa6bf3 JB	134	#define I40E_TX_FLAGS_VLAN_MASK 0xffff0000
	135	#define I40E_TX_FLAGS_VLAN_PRIO_MASK 0xe0000000
	136	#define I40E_TX_FLAGS_VLAN_PRIO_SHIFT 29
	137	#define I40E_TX_FLAGS_VLAN_SHIFT 16
	138
	139	struct i40e_tx_buffer {
7daa6bf3	140	struct i40e_tx_desc *next_to_watch;
35a1e2ad	141	unsigned long time_stamp;
49d7d933 ASJ	142	union {
	143	struct sk_buff *skb;
	144	void *raw_buf;
	145	};
7daa6bf3	146	unsigned int bytecount;
35a1e2ad AD	147	unsigned short gso_segs;
	148	DEFINE_DMA_UNMAP_ADDR(dma);
	149	DEFINE_DMA_UNMAP_LEN(len);
	150	u32 tx_flags;
7daa6bf3 JB	151	};
	152
	153	struct i40e_rx_buffer {
	154	struct sk_buff *skb;
	155	dma_addr_t dma;
	156	struct page *page;
	157	dma_addr_t page_dma;
	158	unsigned int page_offset;
	159	};
	160
a114d0a6	161	struct i40e_queue_stats {
7daa6bf3 JB	162	u64 packets;
7daa6bf3 JB	163	u64 bytes;
a114d0a6 AD	164	};
	165
	166	struct i40e_tx_queue_stats {
7daa6bf3 JB	167	u64 restart_queue;
7daa6bf3 JB	168	u64 tx_busy;
7daa6bf3 JB	169	u64 tx_done_old;
	170	};
	171
	172	struct i40e_rx_queue_stats {
7daa6bf3	173	u64 non_eop_descs;
420136cc MW	174	u64 alloc_page_failed;
420136cc MW	175	u64 alloc_buff_failed;
7daa6bf3 JB	176	};
	177
	178	enum i40e_ring_state_t {
	179	__I40E_TX_FDIR_INIT_DONE,
	180	__I40E_TX_XPS_INIT_DONE,
	181	__I40E_TX_DETECT_HANG,
	182	__I40E_HANG_CHECK_ARMED,
	183	__I40E_RX_PS_ENABLED,
7daa6bf3 JB	184	__I40E_RX_16BYTE_DESC_ENABLED,
	185	};
	186
	187	#define ring_is_ps_enabled(ring) \
	188	test_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
	189	#define set_ring_ps_enabled(ring) \
	190	set_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
	191	#define clear_ring_ps_enabled(ring) \
	192	clear_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
	193	#define check_for_tx_hang(ring) \
	194	test_bit(__I40E_TX_DETECT_HANG, &(ring)->state)
	195	#define set_check_for_tx_hang(ring) \
	196	set_bit(__I40E_TX_DETECT_HANG, &(ring)->state)
	197	#define clear_check_for_tx_hang(ring) \
	198	clear_bit(__I40E_TX_DETECT_HANG, &(ring)->state)
7daa6bf3 JB	199	#define ring_is_16byte_desc_enabled(ring) \
	200	test_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
	201	#define set_ring_16byte_desc_enabled(ring) \
	202	set_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
	203	#define clear_ring_16byte_desc_enabled(ring) \
	204	clear_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
	205
	206	/* struct that defines a descriptor ring, associated with a VSI */
	207	struct i40e_ring {
cd0b6fa6	208	struct i40e_ring next; / pointer to next ring in q_vector */
7daa6bf3 JB	209	void desc; / Descriptor ring memory */
	210	struct device dev; / Used for DMA mapping */
	211	struct net_device netdev; / netdev ring maps to */
	212	union {
	213	struct i40e_tx_buffer *tx_bi;
	214	struct i40e_rx_buffer *rx_bi;
	215	};
	216	unsigned long state;
	217	u16 queue_index; /* Queue number of ring */
	218	u8 dcb_tc; /* Traffic class of ring */
	219	u8 __iomem *tail;
	220
	221	u16 count; /* Number of descriptors */
	222	u16 reg_idx; /* HW register index of the ring */
	223	u16 rx_hdr_len;
	224	u16 rx_buf_len;
	225	u8 dtype;
	226	#define I40E_RX_DTYPE_NO_SPLIT 0
	227	#define I40E_RX_DTYPE_SPLIT_ALWAYS 1
	228	#define I40E_RX_DTYPE_HEADER_SPLIT 2
	229	u8 hsplit;
	230	#define I40E_RX_SPLIT_L2 0x1
	231	#define I40E_RX_SPLIT_IP 0x2
	232	#define I40E_RX_SPLIT_TCP_UDP 0x4
	233	#define I40E_RX_SPLIT_SCTP 0x8
	234
	235	/* used in interrupt processing */
	236	u16 next_to_use;
	237	u16 next_to_clean;
	238
	239	u8 atr_sample_rate;
	240	u8 atr_count;
	241
beb0dff1 JK	242	unsigned long last_rx_timestamp;
beb0dff1 JK	243
7daa6bf3	244	bool ring_active; /* is ring online or not */
d91649f5	245	bool arm_wb; /* do something to arm write back */
7daa6bf3 JB	246
7daa6bf3 JB	247	/* stats structs */
a114d0a6	248	struct i40e_queue_stats stats;
980e9b11	249	struct u64_stats_sync syncp;
7daa6bf3 JB	250	union {
	251	struct i40e_tx_queue_stats tx_stats;
	252	struct i40e_rx_queue_stats rx_stats;
	253	};
	254
	255	unsigned int size; /* length of descriptor ring in bytes */
	256	dma_addr_t dma; /* physical address of ring */
	257
	258	struct i40e_vsi vsi; / Backreference to associated VSI */
	259	struct i40e_q_vector q_vector; / Backreference to associated vector */
9f65e15b AD	260
9f65e15b AD	261	struct rcu_head rcu; /* to avoid race on free */
7daa6bf3 JB	262	} ____cacheline_internodealigned_in_smp;
	263
	264	enum i40e_latency_range {
	265	I40E_LOWEST_LATENCY = 0,
	266	I40E_LOW_LATENCY = 1,
	267	I40E_BULK_LATENCY = 2,
	268	};
	269
	270	struct i40e_ring_container {
7daa6bf3	271	/* array of pointers to rings */
cd0b6fa6	272	struct i40e_ring *ring;
7daa6bf3 JB	273	unsigned int total_bytes; /* total bytes processed this int */
	274	unsigned int total_packets; /* total packets processed this int */
	275	u16 count;
	276	enum i40e_latency_range latency_range;
	277	u16 itr;
	278	};
	279
cd0b6fa6 AD	280	/* iterator for handling rings in ring container */
	281	#define i40e_for_each_ring(pos, head) \
	282	for (pos = (head).ring; pos != NULL; pos = pos->next)
	283
7daa6bf3 JB	284	void i40e_alloc_rx_buffers(struct i40e_ring *rxr, u16 cleaned_count);
	285	netdev_tx_t i40e_lan_xmit_frame(struct sk_buff skb, struct net_device netdev);
	286	void i40e_clean_tx_ring(struct i40e_ring *tx_ring);
	287	void i40e_clean_rx_ring(struct i40e_ring *rx_ring);
	288	int i40e_setup_tx_descriptors(struct i40e_ring *tx_ring);
	289	int i40e_setup_rx_descriptors(struct i40e_ring *rx_ring);
	290	void i40e_free_tx_resources(struct i40e_ring *tx_ring);
	291	void i40e_free_rx_resources(struct i40e_ring *rx_ring);
	292	int i40e_napi_poll(struct napi_struct *napi, int budget);
38e00438 VD	293	#ifdef I40E_FCOE
	294	void i40e_tx_map(struct i40e_ring tx_ring, struct sk_buff skb,
	295	struct i40e_tx_buffer *first, u32 tx_flags,
	296	const u8 hdr_len, u32 td_cmd, u32 td_offset);
	297	int i40e_maybe_stop_tx(struct i40e_ring *tx_ring, int size);
	298	int i40e_xmit_descriptor_count(struct sk_buff skb, struct i40e_ring tx_ring);
	299	int i40e_tx_prepare_vlan_flags(struct sk_buff *skb,
	300	struct i40e_ring tx_ring, u32 flags);
	301	#endif
36fac581	302	#endif /* _I40E_TXRX_H_ */