blob: 5f03c444c89b2c3c7eef77de10a3f983b1786028 [file] [log] [blame]
Greg Rose5321a212013-12-21 06:13:06 +00001/*******************************************************************************
2 *
3 * Intel Ethernet Controller XL710 Family Linux Virtual Function Driver
Anjali Singhai Jainecc6a232016-01-13 16:51:43 -08004 * Copyright(c) 2013 - 2016 Intel Corporation.
Greg Rose5321a212013-12-21 06:13:06 +00005 *
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 *
Jesse Brandeburgb8316072014-04-05 07:46:11 +000015 * You should have received a copy of the GNU General Public License along
16 * with this program. If not, see <http://www.gnu.org/licenses/>.
17 *
Greg Rose5321a212013-12-21 06:13:06 +000018 * 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
27#ifndef _I40E_TXRX_H_
28#define _I40E_TXRX_H_
29
Jesse Brandeburgaee80872014-04-09 05:59:02 +000030/* Interrupt Throttling and Rate Limiting Goodies */
Greg Rose5321a212013-12-21 06:13:06 +000031
32#define I40E_MAX_ITR 0x0FF0 /* reg uses 2 usec resolution */
Jesse Brandeburg79442d32014-10-25 03:24:32 +000033#define I40E_MIN_ITR 0x0001 /* reg uses 2 usec resolution */
Greg Rose5321a212013-12-21 06:13:06 +000034#define I40E_ITR_100K 0x0005
Jesse Brandeburgc56625d2015-09-28 14:16:53 -040035#define I40E_ITR_50K 0x000A
Greg Rose5321a212013-12-21 06:13:06 +000036#define I40E_ITR_20K 0x0019
Jesse Brandeburgc56625d2015-09-28 14:16:53 -040037#define I40E_ITR_18K 0x001B
Greg Rose5321a212013-12-21 06:13:06 +000038#define I40E_ITR_8K 0x003E
39#define I40E_ITR_4K 0x007A
Jesse Brandeburgac26fc12015-09-28 14:12:37 -040040#define I40E_MAX_INTRL 0x3B /* reg uses 4 usec resolution */
Jesse Brandeburgee2319c2015-09-28 14:16:54 -040041#define I40E_ITR_RX_DEF I40E_ITR_20K
42#define I40E_ITR_TX_DEF I40E_ITR_20K
Greg Rose5321a212013-12-21 06:13:06 +000043#define I40E_ITR_DYNAMIC 0x8000 /* use top bit as a flag */
44#define I40E_MIN_INT_RATE 250 /* ~= 1000000 / (I40E_MAX_ITR * 2) */
45#define I40E_MAX_INT_RATE 500000 /* == 1000000 / (I40E_MIN_ITR * 2) */
46#define I40E_DEFAULT_IRQ_WORK 256
47#define ITR_TO_REG(setting) ((setting & ~I40E_ITR_DYNAMIC) >> 1)
48#define ITR_IS_DYNAMIC(setting) (!!(setting & I40E_ITR_DYNAMIC))
49#define ITR_REG_TO_USEC(itr_reg) (itr_reg << 1)
Jesse Brandeburgac26fc12015-09-28 14:12:37 -040050/* 0x40 is the enable bit for interrupt rate limiting, and must be set if
51 * the value of the rate limit is non-zero
52 */
53#define INTRL_ENA BIT(6)
54#define INTRL_REG_TO_USEC(intrl) ((intrl & ~INTRL_ENA) << 2)
55#define INTRL_USEC_TO_REG(set) ((set) ? ((set) >> 2) | INTRL_ENA : 0)
56#define I40E_INTRL_8K 125 /* 8000 ints/sec */
57#define I40E_INTRL_62K 16 /* 62500 ints/sec */
58#define I40E_INTRL_83K 12 /* 83333 ints/sec */
Greg Rose5321a212013-12-21 06:13:06 +000059
60#define I40E_QUEUE_END_OF_LIST 0x7FF
61
62/* this enum matches hardware bits and is meant to be used by DYN_CTLN
63 * registers and QINT registers or more generally anywhere in the manual
64 * mentioning ITR_INDX, ITR_NONE cannot be used as an index 'n' into any
65 * register but instead is a special value meaning "don't update" ITR0/1/2.
66 */
67enum i40e_dyn_idx_t {
68 I40E_IDX_ITR0 = 0,
69 I40E_IDX_ITR1 = 1,
70 I40E_IDX_ITR2 = 2,
71 I40E_ITR_NONE = 3 /* ITR_NONE must not be used as an index */
72};
73
74/* these are indexes into ITRN registers */
75#define I40E_RX_ITR I40E_IDX_ITR0
76#define I40E_TX_ITR I40E_IDX_ITR1
77#define I40E_PE_ITR I40E_IDX_ITR2
78
79/* Supported RSS offloads */
80#define I40E_DEFAULT_RSS_HENA ( \
Jesse Brandeburg41a1d042015-06-04 16:24:02 -040081 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV4_UDP) | \
82 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV4_SCTP) | \
83 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV4_TCP) | \
84 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV4_OTHER) | \
85 BIT_ULL(I40E_FILTER_PCTYPE_FRAG_IPV4) | \
86 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV6_UDP) | \
87 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV6_TCP) | \
88 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV6_SCTP) | \
89 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV6_OTHER) | \
90 BIT_ULL(I40E_FILTER_PCTYPE_FRAG_IPV6) | \
91 BIT_ULL(I40E_FILTER_PCTYPE_L2_PAYLOAD))
Greg Rose5321a212013-12-21 06:13:06 +000092
Anjali Singhai Jaine25d00b2015-06-23 19:00:04 -040093#define I40E_DEFAULT_RSS_HENA_EXPANDED (I40E_DEFAULT_RSS_HENA | \
Jesse Brandeburgd08f5552015-09-16 19:01:08 -070094 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV4_TCP_SYN_NO_ACK) | \
95 BIT_ULL(I40E_FILTER_PCTYPE_NONF_UNICAST_IPV4_UDP) | \
96 BIT_ULL(I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV4_UDP) | \
97 BIT_ULL(I40E_FILTER_PCTYPE_NONF_IPV6_TCP_SYN_NO_ACK) | \
98 BIT_ULL(I40E_FILTER_PCTYPE_NONF_UNICAST_IPV6_UDP) | \
99 BIT_ULL(I40E_FILTER_PCTYPE_NONF_MULTICAST_IPV6_UDP))
Anjali Singhai Jaine25d00b2015-06-23 19:00:04 -0400100
101#define i40e_pf_get_default_rss_hena(pf) \
102 (((pf)->flags & I40E_FLAG_MULTIPLE_TCP_UDP_RSS_PCTYPE) ? \
Jesse Brandeburgd08f5552015-09-16 19:01:08 -0700103 I40E_DEFAULT_RSS_HENA_EXPANDED : I40E_DEFAULT_RSS_HENA)
Anjali Singhai Jaine25d00b2015-06-23 19:00:04 -0400104
Greg Rose5321a212013-12-21 06:13:06 +0000105/* Supported Rx Buffer Sizes */
106#define I40E_RXBUFFER_512 512 /* Used for packet split */
107#define I40E_RXBUFFER_2048 2048
108#define I40E_RXBUFFER_3072 3072 /* For FCoE MTU of 2158 */
109#define I40E_RXBUFFER_4096 4096
110#define I40E_RXBUFFER_8192 8192
111#define I40E_MAX_RXBUFFER 9728 /* largest size for single descriptor */
112
113/* NOTE: netdev_alloc_skb reserves up to 64 bytes, NET_IP_ALIGN means we
114 * reserve 2 more, and skb_shared_info adds an additional 384 bytes more,
115 * this adds up to 512 bytes of extra data meaning the smallest allocation
116 * we could have is 1K.
117 * i.e. RXBUFFER_512 --> size-1024 slab
118 */
119#define I40E_RX_HDR_SIZE I40E_RXBUFFER_512
120
121/* How many Rx Buffers do we bundle into one write to the hardware ? */
122#define I40E_RX_BUFFER_WRITE 16 /* Must be power of 2 */
Mitch Williamsa132af22015-01-24 09:58:35 +0000123#define I40E_RX_INCREMENT(r, i) \
124 do { \
125 (i)++; \
126 if ((i) == (r)->count) \
127 i = 0; \
128 r->next_to_clean = i; \
129 } while (0)
130
Greg Rose5321a212013-12-21 06:13:06 +0000131#define I40E_RX_NEXT_DESC(r, i, n) \
132 do { \
133 (i)++; \
134 if ((i) == (r)->count) \
135 i = 0; \
136 (n) = I40E_RX_DESC((r), (i)); \
137 } while (0)
138
139#define I40E_RX_NEXT_DESC_PREFETCH(r, i, n) \
140 do { \
141 I40E_RX_NEXT_DESC((r), (i), (n)); \
142 prefetch((n)); \
143 } while (0)
144
145#define i40e_rx_desc i40e_32byte_rx_desc
146
Anjali Singhai71da6192015-02-21 06:42:35 +0000147#define I40E_MAX_BUFFER_TXD 8
Greg Rose5321a212013-12-21 06:13:06 +0000148#define I40E_MIN_TX_LEN 17
Jesse Brandeburg980093e2014-05-10 04:49:12 +0000149#define I40E_MAX_DATA_PER_TXD 8192
Greg Rose5321a212013-12-21 06:13:06 +0000150
151/* Tx Descriptors needed, worst case */
152#define TXD_USE_COUNT(S) DIV_ROUND_UP((S), I40E_MAX_DATA_PER_TXD)
Jesse Brandeburg980093e2014-05-10 04:49:12 +0000153#define DESC_NEEDED (MAX_SKB_FRAGS + 4)
Anjali Singhai Jain810b3ae2014-07-10 07:58:25 +0000154#define I40E_MIN_DESC_PENDING 4
Greg Rose5321a212013-12-21 06:13:06 +0000155
Jesse Brandeburg41a1d042015-06-04 16:24:02 -0400156#define I40E_TX_FLAGS_CSUM BIT(0)
157#define I40E_TX_FLAGS_HW_VLAN BIT(1)
158#define I40E_TX_FLAGS_SW_VLAN BIT(2)
159#define I40E_TX_FLAGS_TSO BIT(3)
160#define I40E_TX_FLAGS_IPV4 BIT(4)
161#define I40E_TX_FLAGS_IPV6 BIT(5)
162#define I40E_TX_FLAGS_FCCRC BIT(6)
163#define I40E_TX_FLAGS_FSO BIT(7)
164#define I40E_TX_FLAGS_FD_SB BIT(9)
165#define I40E_TX_FLAGS_VXLAN_TUNNEL BIT(10)
Greg Rose5321a212013-12-21 06:13:06 +0000166#define I40E_TX_FLAGS_VLAN_MASK 0xffff0000
167#define I40E_TX_FLAGS_VLAN_PRIO_MASK 0xe0000000
168#define I40E_TX_FLAGS_VLAN_PRIO_SHIFT 29
169#define I40E_TX_FLAGS_VLAN_SHIFT 16
170
171struct i40e_tx_buffer {
172 struct i40e_tx_desc *next_to_watch;
Anjali Singhai Jain49d7d932014-06-04 08:45:15 +0000173 union {
174 struct sk_buff *skb;
175 void *raw_buf;
176 };
Greg Rose5321a212013-12-21 06:13:06 +0000177 unsigned int bytecount;
178 unsigned short gso_segs;
Jesse Brandeburg6995b362015-08-28 17:55:54 -0400179
Greg Rose5321a212013-12-21 06:13:06 +0000180 DEFINE_DMA_UNMAP_ADDR(dma);
181 DEFINE_DMA_UNMAP_LEN(len);
182 u32 tx_flags;
183};
184
185struct i40e_rx_buffer {
186 struct sk_buff *skb;
Mitch Williamsa132af22015-01-24 09:58:35 +0000187 void *hdr_buf;
Greg Rose5321a212013-12-21 06:13:06 +0000188 dma_addr_t dma;
189 struct page *page;
190 dma_addr_t page_dma;
191 unsigned int page_offset;
192};
193
194struct i40e_queue_stats {
195 u64 packets;
196 u64 bytes;
197};
198
199struct i40e_tx_queue_stats {
200 u64 restart_queue;
201 u64 tx_busy;
202 u64 tx_done_old;
Anjali Singhai Jain2fc3d712015-08-27 11:42:29 -0400203 u64 tx_linearize;
Anjali Singhai Jain164c9f52015-10-21 19:47:08 -0400204 u64 tx_force_wb;
Greg Rose5321a212013-12-21 06:13:06 +0000205};
206
207struct i40e_rx_queue_stats {
208 u64 non_eop_descs;
209 u64 alloc_page_failed;
210 u64 alloc_buff_failed;
Mitch Williamsf16704e2016-01-13 16:51:49 -0800211 u64 page_reuse_count;
212 u64 realloc_count;
Greg Rose5321a212013-12-21 06:13:06 +0000213};
214
215enum i40e_ring_state_t {
216 __I40E_TX_FDIR_INIT_DONE,
217 __I40E_TX_XPS_INIT_DONE,
Greg Rose5321a212013-12-21 06:13:06 +0000218 __I40E_RX_PS_ENABLED,
Greg Rose5321a212013-12-21 06:13:06 +0000219 __I40E_RX_16BYTE_DESC_ENABLED,
220};
221
222#define ring_is_ps_enabled(ring) \
223 test_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
224#define set_ring_ps_enabled(ring) \
225 set_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
226#define clear_ring_ps_enabled(ring) \
227 clear_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
Greg Rose5321a212013-12-21 06:13:06 +0000228#define ring_is_16byte_desc_enabled(ring) \
229 test_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
230#define set_ring_16byte_desc_enabled(ring) \
231 set_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
232#define clear_ring_16byte_desc_enabled(ring) \
233 clear_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
234
235/* struct that defines a descriptor ring, associated with a VSI */
236struct i40e_ring {
237 struct i40e_ring *next; /* pointer to next ring in q_vector */
238 void *desc; /* Descriptor ring memory */
239 struct device *dev; /* Used for DMA mapping */
240 struct net_device *netdev; /* netdev ring maps to */
241 union {
242 struct i40e_tx_buffer *tx_bi;
243 struct i40e_rx_buffer *rx_bi;
244 };
245 unsigned long state;
246 u16 queue_index; /* Queue number of ring */
247 u8 dcb_tc; /* Traffic class of ring */
248 u8 __iomem *tail;
249
250 u16 count; /* Number of descriptors */
251 u16 reg_idx; /* HW register index of the ring */
252 u16 rx_hdr_len;
253 u16 rx_buf_len;
254 u8 dtype;
255#define I40E_RX_DTYPE_NO_SPLIT 0
Mitch Williamsa132af22015-01-24 09:58:35 +0000256#define I40E_RX_DTYPE_HEADER_SPLIT 1
257#define I40E_RX_DTYPE_SPLIT_ALWAYS 2
Greg Rose5321a212013-12-21 06:13:06 +0000258 u8 hsplit;
259#define I40E_RX_SPLIT_L2 0x1
260#define I40E_RX_SPLIT_IP 0x2
261#define I40E_RX_SPLIT_TCP_UDP 0x4
262#define I40E_RX_SPLIT_SCTP 0x8
263
264 /* used in interrupt processing */
265 u16 next_to_use;
266 u16 next_to_clean;
267
268 u8 atr_sample_rate;
269 u8 atr_count;
270
271 bool ring_active; /* is ring online or not */
Anjali Singhai Jainc29af372015-01-10 01:07:19 +0000272 bool arm_wb; /* do something to arm write back */
Anjali Singhai Jain6a7fded2015-10-26 19:44:29 -0400273 u8 packet_stride;
274#define I40E_TXR_FLAGS_LAST_XMIT_MORE_SET BIT(2)
Greg Rose5321a212013-12-21 06:13:06 +0000275
Anjali Singhai Jain8e0764b2015-06-05 12:20:30 -0400276 u16 flags;
277#define I40E_TXR_FLAGS_WB_ON_ITR BIT(0)
Anjali Singhai Jain527274c2015-06-05 12:20:31 -0400278#define I40E_TXR_FLAGS_OUTER_UDP_CSUM BIT(1)
279
Greg Rose5321a212013-12-21 06:13:06 +0000280 /* stats structs */
281 struct i40e_queue_stats stats;
282 struct u64_stats_sync syncp;
283 union {
284 struct i40e_tx_queue_stats tx_stats;
285 struct i40e_rx_queue_stats rx_stats;
286 };
287
288 unsigned int size; /* length of descriptor ring in bytes */
289 dma_addr_t dma; /* physical address of ring */
290
291 struct i40e_vsi *vsi; /* Backreference to associated VSI */
292 struct i40e_q_vector *q_vector; /* Backreference to associated vector */
293
294 struct rcu_head rcu; /* to avoid race on free */
295} ____cacheline_internodealigned_in_smp;
296
297enum i40e_latency_range {
298 I40E_LOWEST_LATENCY = 0,
299 I40E_LOW_LATENCY = 1,
300 I40E_BULK_LATENCY = 2,
Jesse Brandeburgc56625d2015-09-28 14:16:53 -0400301 I40E_ULTRA_LATENCY = 3,
Greg Rose5321a212013-12-21 06:13:06 +0000302};
303
304struct i40e_ring_container {
305 /* array of pointers to rings */
306 struct i40e_ring *ring;
307 unsigned int total_bytes; /* total bytes processed this int */
308 unsigned int total_packets; /* total packets processed this int */
309 u16 count;
310 enum i40e_latency_range latency_range;
311 u16 itr;
312};
313
314/* iterator for handling rings in ring container */
315#define i40e_for_each_ring(pos, head) \
316 for (pos = (head).ring; pos != NULL; pos = pos->next)
317
Jesse Brandeburgc2e245a2016-01-13 16:51:46 -0800318bool i40evf_alloc_rx_buffers_ps(struct i40e_ring *rxr, u16 cleaned_count);
319bool i40evf_alloc_rx_buffers_1buf(struct i40e_ring *rxr, u16 cleaned_count);
Mitch Williamsa132af22015-01-24 09:58:35 +0000320void i40evf_alloc_rx_headers(struct i40e_ring *rxr);
Greg Rose5321a212013-12-21 06:13:06 +0000321netdev_tx_t i40evf_xmit_frame(struct sk_buff *skb, struct net_device *netdev);
322void i40evf_clean_tx_ring(struct i40e_ring *tx_ring);
323void i40evf_clean_rx_ring(struct i40e_ring *rx_ring);
324int i40evf_setup_tx_descriptors(struct i40e_ring *tx_ring);
325int i40evf_setup_rx_descriptors(struct i40e_ring *rx_ring);
326void i40evf_free_tx_resources(struct i40e_ring *tx_ring);
327void i40evf_free_rx_resources(struct i40e_ring *rx_ring);
328int i40evf_napi_poll(struct napi_struct *napi, int budget);
Anjali Singhai Jainecc6a232016-01-13 16:51:43 -0800329void i40evf_force_wb(struct i40e_vsi *vsi, struct i40e_q_vector *q_vector);
Kiran Patil9c6c1252015-11-06 15:26:02 -0800330u32 i40evf_get_tx_pending(struct i40e_ring *ring);
331
332/**
333 * i40e_get_head - Retrieve head from head writeback
334 * @tx_ring: Tx ring to fetch head of
335 *
336 * Returns value of Tx ring head based on value stored
337 * in head write-back location
338 **/
339static inline u32 i40e_get_head(struct i40e_ring *tx_ring)
340{
341 void *head = (struct i40e_tx_desc *)tx_ring->desc + tx_ring->count;
342
343 return le32_to_cpu(*(volatile __le32 *)head);
344}
Greg Rose5321a212013-12-21 06:13:06 +0000345#endif /* _I40E_TXRX_H_ */