Commit | Line | Data |
---|---|---|
d1a890fa SB |
1 | /* |
2 | * Linux driver for VMware's vmxnet3 ethernet NIC. | |
3 | * | |
190af10f | 4 | * Copyright (C) 2008-2016, VMware, Inc. All Rights Reserved. |
d1a890fa SB |
5 | * |
6 | * This program is free software; you can redistribute it and/or modify it | |
7 | * under the terms of the GNU General Public License as published by the | |
8 | * Free Software Foundation; version 2 of the License and no later version. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, but | |
11 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or | |
13 | * NON INFRINGEMENT. See the GNU General Public License for more | |
14 | * details. | |
15 | * | |
16 | * You should have received a copy of the GNU General Public License | |
17 | * along with this program; if not, write to the Free Software | |
18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
19 | * | |
20 | * The full GNU General Public License is included in this distribution in | |
21 | * the file called "COPYING". | |
22 | * | |
190af10f | 23 | * Maintained by: pv-drivers@vmware.com |
d1a890fa SB |
24 | * |
25 | */ | |
26 | ||
27 | #ifndef _VMXNET3_INT_H | |
28 | #define _VMXNET3_INT_H | |
29 | ||
72e85c45 | 30 | #include <linux/bitops.h> |
d1a890fa SB |
31 | #include <linux/ethtool.h> |
32 | #include <linux/delay.h> | |
33 | #include <linux/netdevice.h> | |
34 | #include <linux/pci.h> | |
d1a890fa | 35 | #include <linux/compiler.h> |
d1a890fa SB |
36 | #include <linux/slab.h> |
37 | #include <linux/spinlock.h> | |
38 | #include <linux/ioport.h> | |
39 | #include <linux/highmem.h> | |
d1a890fa SB |
40 | #include <linux/timer.h> |
41 | #include <linux/skbuff.h> | |
42 | #include <linux/interrupt.h> | |
43 | #include <linux/workqueue.h> | |
44 | #include <linux/uaccess.h> | |
45 | #include <asm/dma.h> | |
46 | #include <asm/page.h> | |
47 | ||
48 | #include <linux/tcp.h> | |
49 | #include <linux/udp.h> | |
50 | #include <linux/ip.h> | |
51 | #include <linux/ipv6.h> | |
52 | #include <linux/in.h> | |
53 | #include <linux/etherdevice.h> | |
54 | #include <asm/checksum.h> | |
55 | #include <linux/if_vlan.h> | |
56 | #include <linux/if_arp.h> | |
57 | #include <linux/inetdevice.h> | |
eebb02b1 | 58 | #include <linux/log2.h> |
d1a890fa SB |
59 | |
60 | #include "vmxnet3_defs.h" | |
61 | ||
62 | #ifdef DEBUG | |
63 | # define VMXNET3_DRIVER_VERSION_REPORT VMXNET3_DRIVER_VERSION_STRING"-NAPI(debug)" | |
64 | #else | |
65 | # define VMXNET3_DRIVER_VERSION_REPORT VMXNET3_DRIVER_VERSION_STRING"-NAPI" | |
66 | #endif | |
67 | ||
68 | ||
69 | /* | |
70 | * Version numbers | |
71 | */ | |
50219538 | 72 | #define VMXNET3_DRIVER_VERSION_STRING "1.4.8.0-k" |
d1a890fa SB |
73 | |
74 | /* a 32-bit int, each byte encode a verion number in VMXNET3_DRIVER_VERSION */ | |
50219538 | 75 | #define VMXNET3_DRIVER_VERSION_NUM 0x01040800 |
d1a890fa | 76 | |
09c5088e SB |
77 | #if defined(CONFIG_PCI_MSI) |
78 | /* RSS only makes sense if MSI-X is supported. */ | |
79 | #define VMXNET3_RSS | |
80 | #endif | |
d1a890fa | 81 | |
190af10f SK |
82 | #define VMXNET3_REV_3 2 /* Vmxnet3 Rev. 3 */ |
83 | #define VMXNET3_REV_2 1 /* Vmxnet3 Rev. 2 */ | |
84 | #define VMXNET3_REV_1 0 /* Vmxnet3 Rev. 1 */ | |
85 | ||
d1a890fa SB |
86 | /* |
87 | * Capabilities | |
88 | */ | |
89 | ||
90 | enum { | |
91 | VMNET_CAP_SG = 0x0001, /* Can do scatter-gather transmits. */ | |
92 | VMNET_CAP_IP4_CSUM = 0x0002, /* Can checksum only TCP/UDP over | |
93 | * IPv4 */ | |
94 | VMNET_CAP_HW_CSUM = 0x0004, /* Can checksum all packets. */ | |
95 | VMNET_CAP_HIGH_DMA = 0x0008, /* Can DMA to high memory. */ | |
96 | VMNET_CAP_TOE = 0x0010, /* Supports TCP/IP offload. */ | |
97 | VMNET_CAP_TSO = 0x0020, /* Supports TCP Segmentation | |
98 | * offload */ | |
99 | VMNET_CAP_SW_TSO = 0x0040, /* Supports SW TCP Segmentation */ | |
100 | VMNET_CAP_VMXNET_APROM = 0x0080, /* Vmxnet APROM support */ | |
101 | VMNET_CAP_HW_TX_VLAN = 0x0100, /* Can we do VLAN tagging in HW */ | |
102 | VMNET_CAP_HW_RX_VLAN = 0x0200, /* Can we do VLAN untagging in HW */ | |
103 | VMNET_CAP_SW_VLAN = 0x0400, /* VLAN tagging/untagging in SW */ | |
104 | VMNET_CAP_WAKE_PCKT_RCV = 0x0800, /* Can wake on network packet recv? */ | |
105 | VMNET_CAP_ENABLE_INT_INLINE = 0x1000, /* Enable Interrupt Inline */ | |
106 | VMNET_CAP_ENABLE_HEADER_COPY = 0x2000, /* copy header for vmkernel */ | |
107 | VMNET_CAP_TX_CHAIN = 0x4000, /* Guest can use multiple tx entries | |
108 | * for a pkt */ | |
109 | VMNET_CAP_RX_CHAIN = 0x8000, /* pkt can span multiple rx entries */ | |
110 | VMNET_CAP_LPD = 0x10000, /* large pkt delivery */ | |
111 | VMNET_CAP_BPF = 0x20000, /* BPF Support in VMXNET Virtual HW*/ | |
112 | VMNET_CAP_SG_SPAN_PAGES = 0x40000, /* Scatter-gather can span multiple*/ | |
113 | /* pages transmits */ | |
114 | VMNET_CAP_IP6_CSUM = 0x80000, /* Can do IPv6 csum offload. */ | |
115 | VMNET_CAP_TSO6 = 0x100000, /* TSO seg. offload for IPv6 pkts. */ | |
116 | VMNET_CAP_TSO256k = 0x200000, /* Can do TSO seg offload for */ | |
117 | /* pkts up to 256kB. */ | |
118 | VMNET_CAP_UPT = 0x400000 /* Support UPT */ | |
119 | }; | |
120 | ||
121 | /* | |
122 | * PCI vendor and device IDs. | |
123 | */ | |
d1a890fa SB |
124 | #define PCI_DEVICE_ID_VMWARE_VMXNET3 0x07B0 |
125 | #define MAX_ETHERNET_CARDS 10 | |
126 | #define MAX_PCI_PASSTHRU_DEVICE 6 | |
127 | ||
128 | struct vmxnet3_cmd_ring { | |
129 | union Vmxnet3_GenericDesc *base; | |
130 | u32 size; | |
131 | u32 next2fill; | |
132 | u32 next2comp; | |
133 | u8 gen; | |
134 | dma_addr_t basePA; | |
135 | }; | |
136 | ||
137 | static inline void | |
138 | vmxnet3_cmd_ring_adv_next2fill(struct vmxnet3_cmd_ring *ring) | |
139 | { | |
140 | ring->next2fill++; | |
141 | if (unlikely(ring->next2fill == ring->size)) { | |
142 | ring->next2fill = 0; | |
143 | VMXNET3_FLIP_RING_GEN(ring->gen); | |
144 | } | |
145 | } | |
146 | ||
147 | static inline void | |
148 | vmxnet3_cmd_ring_adv_next2comp(struct vmxnet3_cmd_ring *ring) | |
149 | { | |
150 | VMXNET3_INC_RING_IDX_ONLY(ring->next2comp, ring->size); | |
151 | } | |
152 | ||
153 | static inline int | |
154 | vmxnet3_cmd_ring_desc_avail(struct vmxnet3_cmd_ring *ring) | |
155 | { | |
156 | return (ring->next2comp > ring->next2fill ? 0 : ring->size) + | |
157 | ring->next2comp - ring->next2fill - 1; | |
158 | } | |
159 | ||
160 | struct vmxnet3_comp_ring { | |
161 | union Vmxnet3_GenericDesc *base; | |
162 | u32 size; | |
163 | u32 next2proc; | |
164 | u8 gen; | |
165 | u8 intr_idx; | |
166 | dma_addr_t basePA; | |
167 | }; | |
168 | ||
169 | static inline void | |
170 | vmxnet3_comp_ring_adv_next2proc(struct vmxnet3_comp_ring *ring) | |
171 | { | |
172 | ring->next2proc++; | |
173 | if (unlikely(ring->next2proc == ring->size)) { | |
174 | ring->next2proc = 0; | |
175 | VMXNET3_FLIP_RING_GEN(ring->gen); | |
176 | } | |
177 | } | |
178 | ||
179 | struct vmxnet3_tx_data_ring { | |
180 | struct Vmxnet3_TxDataDesc *base; | |
181 | u32 size; | |
182 | dma_addr_t basePA; | |
183 | }; | |
184 | ||
185 | enum vmxnet3_buf_map_type { | |
186 | VMXNET3_MAP_INVALID = 0, | |
187 | VMXNET3_MAP_NONE, | |
188 | VMXNET3_MAP_SINGLE, | |
189 | VMXNET3_MAP_PAGE, | |
190 | }; | |
191 | ||
192 | struct vmxnet3_tx_buf_info { | |
193 | u32 map_type; | |
194 | u16 len; | |
195 | u16 sop_idx; | |
196 | dma_addr_t dma_addr; | |
197 | struct sk_buff *skb; | |
198 | }; | |
199 | ||
200 | struct vmxnet3_tq_driver_stats { | |
201 | u64 drop_total; /* # of pkts dropped by the driver, the | |
202 | * counters below track droppings due to | |
203 | * different reasons | |
204 | */ | |
205 | u64 drop_too_many_frags; | |
206 | u64 drop_oversized_hdr; | |
207 | u64 drop_hdr_inspect_err; | |
208 | u64 drop_tso; | |
209 | ||
210 | u64 tx_ring_full; | |
211 | u64 linearized; /* # of pkts linearized */ | |
212 | u64 copy_skb_header; /* # of times we have to copy skb header */ | |
213 | u64 oversized_hdr; | |
214 | }; | |
215 | ||
216 | struct vmxnet3_tx_ctx { | |
217 | bool ipv4; | |
759c9359 | 218 | bool ipv6; |
d1a890fa SB |
219 | u16 mss; |
220 | u32 eth_ip_hdr_size; /* only valid for pkts requesting tso or csum | |
221 | * offloading | |
222 | */ | |
223 | u32 l4_hdr_size; /* only valid if mss != 0 */ | |
224 | u32 copy_size; /* # of bytes copied into the data ring */ | |
225 | union Vmxnet3_GenericDesc *sop_txd; | |
226 | union Vmxnet3_GenericDesc *eop_txd; | |
227 | }; | |
228 | ||
229 | struct vmxnet3_tx_queue { | |
09c5088e SB |
230 | char name[IFNAMSIZ+8]; /* To identify interrupt */ |
231 | struct vmxnet3_adapter *adapter; | |
d1a890fa SB |
232 | spinlock_t tx_lock; |
233 | struct vmxnet3_cmd_ring tx_ring; | |
09c5088e | 234 | struct vmxnet3_tx_buf_info *buf_info; |
b0eb57cb | 235 | dma_addr_t buf_info_pa; |
d1a890fa SB |
236 | struct vmxnet3_tx_data_ring data_ring; |
237 | struct vmxnet3_comp_ring comp_ring; | |
09c5088e | 238 | struct Vmxnet3_TxQueueCtrl *shared; |
d1a890fa SB |
239 | struct vmxnet3_tq_driver_stats stats; |
240 | bool stopped; | |
241 | int num_stop; /* # of times the queue is | |
242 | * stopped */ | |
09c5088e | 243 | int qid; |
d1a890fa SB |
244 | } __attribute__((__aligned__(SMP_CACHE_BYTES))); |
245 | ||
246 | enum vmxnet3_rx_buf_type { | |
247 | VMXNET3_RX_BUF_NONE = 0, | |
248 | VMXNET3_RX_BUF_SKB = 1, | |
249 | VMXNET3_RX_BUF_PAGE = 2 | |
250 | }; | |
251 | ||
252 | struct vmxnet3_rx_buf_info { | |
253 | enum vmxnet3_rx_buf_type buf_type; | |
254 | u16 len; | |
255 | union { | |
256 | struct sk_buff *skb; | |
257 | struct page *page; | |
258 | }; | |
259 | dma_addr_t dma_addr; | |
260 | }; | |
261 | ||
262 | struct vmxnet3_rx_ctx { | |
263 | struct sk_buff *skb; | |
264 | u32 sop_idx; | |
265 | }; | |
266 | ||
267 | struct vmxnet3_rq_driver_stats { | |
268 | u64 drop_total; | |
269 | u64 drop_err; | |
270 | u64 drop_fcs; | |
271 | u64 rx_buf_alloc_failure; | |
272 | }; | |
273 | ||
274 | struct vmxnet3_rx_queue { | |
09c5088e SB |
275 | char name[IFNAMSIZ + 8]; /* To identify interrupt */ |
276 | struct vmxnet3_adapter *adapter; | |
277 | struct napi_struct napi; | |
d1a890fa SB |
278 | struct vmxnet3_cmd_ring rx_ring[2]; |
279 | struct vmxnet3_comp_ring comp_ring; | |
280 | struct vmxnet3_rx_ctx rx_ctx; | |
281 | u32 qid; /* rqID in RCD for buffer from 1st ring */ | |
282 | u32 qid2; /* rqID in RCD for buffer from 2nd ring */ | |
d1a890fa | 283 | struct vmxnet3_rx_buf_info *buf_info[2]; |
b0eb57cb | 284 | dma_addr_t buf_info_pa; |
d1a890fa SB |
285 | struct Vmxnet3_RxQueueCtrl *shared; |
286 | struct vmxnet3_rq_driver_stats stats; | |
287 | } __attribute__((__aligned__(SMP_CACHE_BYTES))); | |
288 | ||
09c5088e SB |
289 | #define VMXNET3_DEVICE_MAX_TX_QUEUES 8 |
290 | #define VMXNET3_DEVICE_MAX_RX_QUEUES 8 /* Keep this value as a power of 2 */ | |
291 | ||
292 | /* Should be less than UPT1_RSS_MAX_IND_TABLE_SIZE */ | |
293 | #define VMXNET3_RSS_IND_TABLE_SIZE (VMXNET3_DEVICE_MAX_RX_QUEUES * 4) | |
294 | ||
295 | #define VMXNET3_LINUX_MAX_MSIX_VECT (VMXNET3_DEVICE_MAX_TX_QUEUES + \ | |
296 | VMXNET3_DEVICE_MAX_RX_QUEUES + 1) | |
7e96fbf2 | 297 | #define VMXNET3_LINUX_MIN_MSIX_VECT 2 /* 1 for tx-rx pair and 1 for event */ |
09c5088e | 298 | |
d1a890fa SB |
299 | |
300 | struct vmxnet3_intr { | |
301 | enum vmxnet3_intr_mask_mode mask_mode; | |
302 | enum vmxnet3_intr_type type; /* MSI-X, MSI, or INTx? */ | |
303 | u8 num_intrs; /* # of intr vectors */ | |
304 | u8 event_intr_idx; /* idx of the intr vector for event */ | |
305 | u8 mod_levels[VMXNET3_LINUX_MAX_MSIX_VECT]; /* moderation level */ | |
09c5088e | 306 | char event_msi_vector_name[IFNAMSIZ+11]; |
d1a890fa SB |
307 | #ifdef CONFIG_PCI_MSI |
308 | struct msix_entry msix_entries[VMXNET3_LINUX_MAX_MSIX_VECT]; | |
309 | #endif | |
310 | }; | |
311 | ||
09c5088e SB |
312 | /* Interrupt sharing schemes, share_intr */ |
313 | #define VMXNET3_INTR_BUDDYSHARE 0 /* Corresponding tx,rx queues share irq */ | |
314 | #define VMXNET3_INTR_TXSHARE 1 /* All tx queues share one irq */ | |
315 | #define VMXNET3_INTR_DONTSHARE 2 /* each queue has its own irq */ | |
316 | ||
317 | ||
d1a890fa SB |
318 | #define VMXNET3_STATE_BIT_RESETTING 0 |
319 | #define VMXNET3_STATE_BIT_QUIESCED 1 | |
320 | struct vmxnet3_adapter { | |
09c5088e SB |
321 | struct vmxnet3_tx_queue tx_queue[VMXNET3_DEVICE_MAX_TX_QUEUES]; |
322 | struct vmxnet3_rx_queue rx_queue[VMXNET3_DEVICE_MAX_RX_QUEUES]; | |
72e85c45 | 323 | unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)]; |
09c5088e | 324 | struct vmxnet3_intr intr; |
83d0feff | 325 | spinlock_t cmd_lock; |
09c5088e SB |
326 | struct Vmxnet3_DriverShared *shared; |
327 | struct Vmxnet3_PMConf *pm_conf; | |
328 | struct Vmxnet3_TxQueueDesc *tqd_start; /* all tx queue desc */ | |
329 | struct Vmxnet3_RxQueueDesc *rqd_start; /* all rx queue desc */ | |
330 | struct net_device *netdev; | |
09c5088e | 331 | struct pci_dev *pdev; |
d1a890fa | 332 | |
81e8e560 HH |
333 | u8 __iomem *hw_addr0; /* for BAR 0 */ |
334 | u8 __iomem *hw_addr1; /* for BAR 1 */ | |
45dac1d6 SB |
335 | u8 version; |
336 | ||
337 | bool rxcsum; | |
338 | bool lro; | |
d1a890fa | 339 | |
09c5088e SB |
340 | #ifdef VMXNET3_RSS |
341 | struct UPT1_RSSConf *rss_conf; | |
342 | bool rss; | |
343 | #endif | |
344 | u32 num_rx_queues; | |
345 | u32 num_tx_queues; | |
d1a890fa SB |
346 | |
347 | /* rx buffer related */ | |
348 | unsigned skb_buf_size; | |
349 | int rx_buf_per_pkt; /* only apply to the 1st ring */ | |
350 | dma_addr_t shared_pa; | |
351 | dma_addr_t queue_desc_pa; | |
352 | ||
353 | /* Wake-on-LAN */ | |
354 | u32 wol; | |
355 | ||
356 | /* Link speed */ | |
357 | u32 link_speed; /* in mbps */ | |
358 | ||
359 | u64 tx_timeout_count; | |
f00e2b0a NH |
360 | |
361 | /* Ring sizes */ | |
362 | u32 tx_ring_size; | |
363 | u32 rx_ring_size; | |
53831aa1 | 364 | u32 rx_ring2_size; |
f00e2b0a | 365 | |
d1a890fa SB |
366 | struct work_struct work; |
367 | ||
368 | unsigned long state; /* VMXNET3_STATE_BIT_xxx */ | |
369 | ||
09c5088e | 370 | int share_intr; |
b0eb57cb AK |
371 | |
372 | dma_addr_t adapter_pa; | |
373 | dma_addr_t pm_conf_pa; | |
374 | dma_addr_t rss_conf_pa; | |
d1a890fa SB |
375 | }; |
376 | ||
377 | #define VMXNET3_WRITE_BAR0_REG(adapter, reg, val) \ | |
b8744cab | 378 | writel((val), (adapter)->hw_addr0 + (reg)) |
d1a890fa | 379 | #define VMXNET3_READ_BAR0_REG(adapter, reg) \ |
b8744cab | 380 | readl((adapter)->hw_addr0 + (reg)) |
d1a890fa SB |
381 | |
382 | #define VMXNET3_WRITE_BAR1_REG(adapter, reg, val) \ | |
b8744cab | 383 | writel((val), (adapter)->hw_addr1 + (reg)) |
d1a890fa | 384 | #define VMXNET3_READ_BAR1_REG(adapter, reg) \ |
b8744cab | 385 | readl((adapter)->hw_addr1 + (reg)) |
d1a890fa SB |
386 | |
387 | #define VMXNET3_WAKE_QUEUE_THRESHOLD(tq) (5) | |
388 | #define VMXNET3_RX_ALLOC_THRESHOLD(rq, ring_idx, adapter) \ | |
389 | ((rq)->rx_ring[ring_idx].size >> 3) | |
390 | ||
391 | #define VMXNET3_GET_ADDR_LO(dma) ((u32)(dma)) | |
392 | #define VMXNET3_GET_ADDR_HI(dma) ((u32)(((u64)(dma)) >> 32)) | |
393 | ||
190af10f SK |
394 | #define VMXNET3_VERSION_GE_2(adapter) \ |
395 | (adapter->version >= VMXNET3_REV_2 + 1) | |
396 | #define VMXNET3_VERSION_GE_3(adapter) \ | |
397 | (adapter->version >= VMXNET3_REV_3 + 1) | |
398 | ||
d1a890fa SB |
399 | /* must be a multiple of VMXNET3_RING_SIZE_ALIGN */ |
400 | #define VMXNET3_DEF_TX_RING_SIZE 512 | |
401 | #define VMXNET3_DEF_RX_RING_SIZE 256 | |
53831aa1 | 402 | #define VMXNET3_DEF_RX_RING2_SIZE 128 |
d1a890fa SB |
403 | |
404 | #define VMXNET3_MAX_ETH_HDR_SIZE 22 | |
405 | #define VMXNET3_MAX_SKB_BUF_SIZE (3*1024) | |
406 | ||
407 | int | |
408 | vmxnet3_quiesce_dev(struct vmxnet3_adapter *adapter); | |
409 | ||
410 | int | |
411 | vmxnet3_activate_dev(struct vmxnet3_adapter *adapter); | |
412 | ||
413 | void | |
414 | vmxnet3_force_close(struct vmxnet3_adapter *adapter); | |
415 | ||
416 | void | |
417 | vmxnet3_reset_dev(struct vmxnet3_adapter *adapter); | |
418 | ||
419 | void | |
09c5088e | 420 | vmxnet3_tq_destroy_all(struct vmxnet3_adapter *adapter); |
d1a890fa SB |
421 | |
422 | void | |
09c5088e | 423 | vmxnet3_rq_destroy_all(struct vmxnet3_adapter *adapter); |
d1a890fa | 424 | |
a0d2730c | 425 | int |
c8f44aff | 426 | vmxnet3_set_features(struct net_device *netdev, netdev_features_t features); |
a0d2730c | 427 | |
d1a890fa SB |
428 | int |
429 | vmxnet3_create_queues(struct vmxnet3_adapter *adapter, | |
430 | u32 tx_ring_size, u32 rx_ring_size, u32 rx_ring2_size); | |
431 | ||
d8dea1eb | 432 | void vmxnet3_set_ethtool_ops(struct net_device *netdev); |
95305f6c | 433 | |
d8dea1eb | 434 | struct rtnl_link_stats64 * |
95305f6c | 435 | vmxnet3_get_stats64(struct net_device *dev, struct rtnl_link_stats64 *stats); |
d1a890fa SB |
436 | |
437 | extern char vmxnet3_driver_name[]; | |
438 | #endif |