i40e: be more informative
[deliverable/linux.git] / drivers / net / ethernet / intel / i40e / i40e_txrx.h
CommitLineData
7daa6bf3
JB
1/*******************************************************************************
2 *
3 * Intel Ethernet Controller XL710 Family Linux Driver
4 * Copyright(c) 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/* Interrupt Throttling and Rate Limiting (storm control) Goodies */
29
30#define I40E_MAX_ITR 0x07FF
31#define I40E_MIN_ITR 0x0001
32#define I40E_ITR_USEC_RESOLUTION 2
33#define I40E_MAX_IRATE 0x03F
34#define I40E_MIN_IRATE 0x001
35#define I40E_IRATE_USEC_RESOLUTION 4
36#define I40E_ITR_100K 0x0005
37#define I40E_ITR_20K 0x0019
38#define I40E_ITR_8K 0x003E
39#define I40E_ITR_4K 0x007A
40#define I40E_ITR_RX_DEF I40E_ITR_8K
41#define I40E_ITR_TX_DEF I40E_ITR_4K
42#define I40E_ITR_DYNAMIC 0x8000 /* use top bit as a flag */
43#define I40E_MIN_INT_RATE 250 /* ~= 1000000 / (I40E_MAX_ITR * 2) */
44#define I40E_MAX_INT_RATE 500000 /* == 1000000 / (I40E_MIN_ITR * 2) */
45#define I40E_DEFAULT_IRQ_WORK 256
46#define ITR_TO_REG(setting) ((setting & ~I40E_ITR_DYNAMIC) >> 1)
47#define ITR_IS_DYNAMIC(setting) (!!(setting & I40E_ITR_DYNAMIC))
48#define ITR_REG_TO_USEC(itr_reg) (itr_reg << 1)
49
50#define I40E_QUEUE_END_OF_LIST 0x7FF
51
0319577f
JB
52/* this enum matches hardware bits and is meant to be used by DYN_CTLN
53 * registers and QINT registers or more generally anywhere in the manual
54 * mentioning ITR_INDX, ITR_NONE cannot be used as an index 'n' into any
55 * register but instead is a special value meaning "don't update" ITR0/1/2.
56 */
57enum i40e_dyn_idx_t {
58 I40E_IDX_ITR0 = 0,
59 I40E_IDX_ITR1 = 1,
60 I40E_IDX_ITR2 = 2,
61 I40E_ITR_NONE = 3 /* ITR_NONE must not be used as an index */
62};
63
64/* these are indexes into ITRN registers */
65#define I40E_RX_ITR I40E_IDX_ITR0
66#define I40E_TX_ITR I40E_IDX_ITR1
67#define I40E_PE_ITR I40E_IDX_ITR2
68
7daa6bf3
JB
69/* Supported Rx Buffer Sizes */
70#define I40E_RXBUFFER_512 512 /* Used for packet split */
71#define I40E_RXBUFFER_2048 2048
72#define I40E_RXBUFFER_3072 3072 /* For FCoE MTU of 2158 */
73#define I40E_RXBUFFER_4096 4096
74#define I40E_RXBUFFER_8192 8192
75#define I40E_MAX_RXBUFFER 9728 /* largest size for single descriptor */
76
77/* NOTE: netdev_alloc_skb reserves up to 64 bytes, NET_IP_ALIGN means we
78 * reserve 2 more, and skb_shared_info adds an additional 384 bytes more,
79 * this adds up to 512 bytes of extra data meaning the smallest allocation
80 * we could have is 1K.
81 * i.e. RXBUFFER_512 --> size-1024 slab
82 */
83#define I40E_RX_HDR_SIZE I40E_RXBUFFER_512
84
85/* How many Rx Buffers do we bundle into one write to the hardware ? */
86#define I40E_RX_BUFFER_WRITE 16 /* Must be power of 2 */
87#define I40E_RX_NEXT_DESC(r, i, n) \
88 do { \
89 (i)++; \
90 if ((i) == (r)->count) \
91 i = 0; \
92 (n) = I40E_RX_DESC((r), (i)); \
93 } while (0)
94
95#define I40E_RX_NEXT_DESC_PREFETCH(r, i, n) \
96 do { \
97 I40E_RX_NEXT_DESC((r), (i), (n)); \
98 prefetch((n)); \
99 } while (0)
100
101#define i40e_rx_desc i40e_32byte_rx_desc
102
103#define I40E_MIN_TX_LEN 17
104#define I40E_MAX_DATA_PER_TXD 16383 /* aka 16kB - 1 */
105
106/* Tx Descriptors needed, worst case */
107#define TXD_USE_COUNT(S) DIV_ROUND_UP((S), I40E_MAX_DATA_PER_TXD)
108#define DESC_NEEDED ((MAX_SKB_FRAGS * TXD_USE_COUNT(PAGE_SIZE)) + 4)
109
110#define I40E_TX_FLAGS_CSUM (u32)(1)
111#define I40E_TX_FLAGS_HW_VLAN (u32)(1 << 1)
112#define I40E_TX_FLAGS_SW_VLAN (u32)(1 << 2)
113#define I40E_TX_FLAGS_TSO (u32)(1 << 3)
114#define I40E_TX_FLAGS_IPV4 (u32)(1 << 4)
115#define I40E_TX_FLAGS_IPV6 (u32)(1 << 5)
116#define I40E_TX_FLAGS_FCCRC (u32)(1 << 6)
117#define I40E_TX_FLAGS_FSO (u32)(1 << 7)
7daa6bf3
JB
118#define I40E_TX_FLAGS_VLAN_MASK 0xffff0000
119#define I40E_TX_FLAGS_VLAN_PRIO_MASK 0xe0000000
120#define I40E_TX_FLAGS_VLAN_PRIO_SHIFT 29
121#define I40E_TX_FLAGS_VLAN_SHIFT 16
122
123struct i40e_tx_buffer {
7daa6bf3 124 struct i40e_tx_desc *next_to_watch;
35a1e2ad
AD
125 unsigned long time_stamp;
126 struct sk_buff *skb;
7daa6bf3 127 unsigned int bytecount;
35a1e2ad
AD
128 unsigned short gso_segs;
129 DEFINE_DMA_UNMAP_ADDR(dma);
130 DEFINE_DMA_UNMAP_LEN(len);
131 u32 tx_flags;
7daa6bf3
JB
132};
133
134struct i40e_rx_buffer {
135 struct sk_buff *skb;
136 dma_addr_t dma;
137 struct page *page;
138 dma_addr_t page_dma;
139 unsigned int page_offset;
140};
141
a114d0a6 142struct i40e_queue_stats {
7daa6bf3
JB
143 u64 packets;
144 u64 bytes;
a114d0a6
AD
145};
146
147struct i40e_tx_queue_stats {
7daa6bf3
JB
148 u64 restart_queue;
149 u64 tx_busy;
7daa6bf3
JB
150 u64 tx_done_old;
151};
152
153struct i40e_rx_queue_stats {
7daa6bf3
JB
154 u64 non_eop_descs;
155 u64 alloc_rx_page_failed;
156 u64 alloc_rx_buff_failed;
157};
158
159enum i40e_ring_state_t {
160 __I40E_TX_FDIR_INIT_DONE,
161 __I40E_TX_XPS_INIT_DONE,
162 __I40E_TX_DETECT_HANG,
163 __I40E_HANG_CHECK_ARMED,
164 __I40E_RX_PS_ENABLED,
165 __I40E_RX_LRO_ENABLED,
166 __I40E_RX_16BYTE_DESC_ENABLED,
167};
168
169#define ring_is_ps_enabled(ring) \
170 test_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
171#define set_ring_ps_enabled(ring) \
172 set_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
173#define clear_ring_ps_enabled(ring) \
174 clear_bit(__I40E_RX_PS_ENABLED, &(ring)->state)
175#define check_for_tx_hang(ring) \
176 test_bit(__I40E_TX_DETECT_HANG, &(ring)->state)
177#define set_check_for_tx_hang(ring) \
178 set_bit(__I40E_TX_DETECT_HANG, &(ring)->state)
179#define clear_check_for_tx_hang(ring) \
180 clear_bit(__I40E_TX_DETECT_HANG, &(ring)->state)
181#define ring_is_lro_enabled(ring) \
182 test_bit(__I40E_RX_LRO_ENABLED, &(ring)->state)
183#define set_ring_lro_enabled(ring) \
184 set_bit(__I40E_RX_LRO_ENABLED, &(ring)->state)
185#define clear_ring_lro_enabled(ring) \
186 clear_bit(__I40E_RX_LRO_ENABLED, &(ring)->state)
187#define ring_is_16byte_desc_enabled(ring) \
188 test_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
189#define set_ring_16byte_desc_enabled(ring) \
190 set_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
191#define clear_ring_16byte_desc_enabled(ring) \
192 clear_bit(__I40E_RX_16BYTE_DESC_ENABLED, &(ring)->state)
193
194/* struct that defines a descriptor ring, associated with a VSI */
195struct i40e_ring {
cd0b6fa6 196 struct i40e_ring *next; /* pointer to next ring in q_vector */
7daa6bf3
JB
197 void *desc; /* Descriptor ring memory */
198 struct device *dev; /* Used for DMA mapping */
199 struct net_device *netdev; /* netdev ring maps to */
200 union {
201 struct i40e_tx_buffer *tx_bi;
202 struct i40e_rx_buffer *rx_bi;
203 };
204 unsigned long state;
205 u16 queue_index; /* Queue number of ring */
206 u8 dcb_tc; /* Traffic class of ring */
207 u8 __iomem *tail;
208
209 u16 count; /* Number of descriptors */
210 u16 reg_idx; /* HW register index of the ring */
211 u16 rx_hdr_len;
212 u16 rx_buf_len;
213 u8 dtype;
214#define I40E_RX_DTYPE_NO_SPLIT 0
215#define I40E_RX_DTYPE_SPLIT_ALWAYS 1
216#define I40E_RX_DTYPE_HEADER_SPLIT 2
217 u8 hsplit;
218#define I40E_RX_SPLIT_L2 0x1
219#define I40E_RX_SPLIT_IP 0x2
220#define I40E_RX_SPLIT_TCP_UDP 0x4
221#define I40E_RX_SPLIT_SCTP 0x8
222
223 /* used in interrupt processing */
224 u16 next_to_use;
225 u16 next_to_clean;
226
227 u8 atr_sample_rate;
228 u8 atr_count;
229
230 bool ring_active; /* is ring online or not */
231
232 /* stats structs */
a114d0a6 233 struct i40e_queue_stats stats;
980e9b11 234 struct u64_stats_sync syncp;
7daa6bf3
JB
235 union {
236 struct i40e_tx_queue_stats tx_stats;
237 struct i40e_rx_queue_stats rx_stats;
238 };
239
240 unsigned int size; /* length of descriptor ring in bytes */
241 dma_addr_t dma; /* physical address of ring */
242
243 struct i40e_vsi *vsi; /* Backreference to associated VSI */
244 struct i40e_q_vector *q_vector; /* Backreference to associated vector */
9f65e15b
AD
245
246 struct rcu_head rcu; /* to avoid race on free */
7daa6bf3
JB
247} ____cacheline_internodealigned_in_smp;
248
249enum i40e_latency_range {
250 I40E_LOWEST_LATENCY = 0,
251 I40E_LOW_LATENCY = 1,
252 I40E_BULK_LATENCY = 2,
253};
254
255struct i40e_ring_container {
7daa6bf3 256 /* array of pointers to rings */
cd0b6fa6 257 struct i40e_ring *ring;
7daa6bf3
JB
258 unsigned int total_bytes; /* total bytes processed this int */
259 unsigned int total_packets; /* total packets processed this int */
260 u16 count;
261 enum i40e_latency_range latency_range;
262 u16 itr;
263};
264
cd0b6fa6
AD
265/* iterator for handling rings in ring container */
266#define i40e_for_each_ring(pos, head) \
267 for (pos = (head).ring; pos != NULL; pos = pos->next)
268
7daa6bf3
JB
269void i40e_alloc_rx_buffers(struct i40e_ring *rxr, u16 cleaned_count);
270netdev_tx_t i40e_lan_xmit_frame(struct sk_buff *skb, struct net_device *netdev);
271void i40e_clean_tx_ring(struct i40e_ring *tx_ring);
272void i40e_clean_rx_ring(struct i40e_ring *rx_ring);
273int i40e_setup_tx_descriptors(struct i40e_ring *tx_ring);
274int i40e_setup_rx_descriptors(struct i40e_ring *rx_ring);
275void i40e_free_tx_resources(struct i40e_ring *tx_ring);
276void i40e_free_rx_resources(struct i40e_ring *rx_ring);
277int i40e_napi_poll(struct napi_struct *napi, int budget);
This page took 0.062844 seconds and 5 git commands to generate.