2 * Linux driver for VMware's vmxnet3 ethernet NIC.
4 * Copyright (C) 2008-2021, VMware, Inc. All Rights Reserved.
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.
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
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.
20 * The full GNU General Public License is included in this distribution in
21 * the file called "COPYING".
23 * Maintained by: pv-drivers@vmware.com
27 #ifndef _VMXNET3_INT_H
28 #define _VMXNET3_INT_H
30 #include <linux/bitops.h>
31 #include <linux/ethtool.h>
32 #include <linux/delay.h>
33 #include <linux/netdevice.h>
34 #include <linux/pci.h>
35 #include <linux/compiler.h>
36 #include <linux/slab.h>
37 #include <linux/spinlock.h>
38 #include <linux/ioport.h>
39 #include <linux/highmem.h>
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>
48 #include <linux/tcp.h>
49 #include <linux/udp.h>
51 #include <linux/ipv6.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>
58 #include <linux/log2.h>
60 #include "vmxnet3_defs.h"
63 # define VMXNET3_DRIVER_VERSION_REPORT VMXNET3_DRIVER_VERSION_STRING"-NAPI(debug)"
65 # define VMXNET3_DRIVER_VERSION_REPORT VMXNET3_DRIVER_VERSION_STRING"-NAPI"
72 #define VMXNET3_DRIVER_VERSION_STRING "1.6.0.0-k"
74 /* Each byte of this 32-bit integer encodes a version number in
75 * VMXNET3_DRIVER_VERSION_STRING.
77 #define VMXNET3_DRIVER_VERSION_NUM 0x01060000
79 #if defined(CONFIG_PCI_MSI)
80 /* RSS only makes sense if MSI-X is supported. */
84 #define VMXNET3_REV_6 5 /* Vmxnet3 Rev. 6 */
85 #define VMXNET3_REV_5 4 /* Vmxnet3 Rev. 5 */
86 #define VMXNET3_REV_4 3 /* Vmxnet3 Rev. 4 */
87 #define VMXNET3_REV_3 2 /* Vmxnet3 Rev. 3 */
88 #define VMXNET3_REV_2 1 /* Vmxnet3 Rev. 2 */
89 #define VMXNET3_REV_1 0 /* Vmxnet3 Rev. 1 */
96 VMNET_CAP_SG = 0x0001, /* Can do scatter-gather transmits. */
97 VMNET_CAP_IP4_CSUM = 0x0002, /* Can checksum only TCP/UDP over
99 VMNET_CAP_HW_CSUM = 0x0004, /* Can checksum all packets. */
100 VMNET_CAP_HIGH_DMA = 0x0008, /* Can DMA to high memory. */
101 VMNET_CAP_TOE = 0x0010, /* Supports TCP/IP offload. */
102 VMNET_CAP_TSO = 0x0020, /* Supports TCP Segmentation
104 VMNET_CAP_SW_TSO = 0x0040, /* Supports SW TCP Segmentation */
105 VMNET_CAP_VMXNET_APROM = 0x0080, /* Vmxnet APROM support */
106 VMNET_CAP_HW_TX_VLAN = 0x0100, /* Can we do VLAN tagging in HW */
107 VMNET_CAP_HW_RX_VLAN = 0x0200, /* Can we do VLAN untagging in HW */
108 VMNET_CAP_SW_VLAN = 0x0400, /* VLAN tagging/untagging in SW */
109 VMNET_CAP_WAKE_PCKT_RCV = 0x0800, /* Can wake on network packet recv? */
110 VMNET_CAP_ENABLE_INT_INLINE = 0x1000, /* Enable Interrupt Inline */
111 VMNET_CAP_ENABLE_HEADER_COPY = 0x2000, /* copy header for vmkernel */
112 VMNET_CAP_TX_CHAIN = 0x4000, /* Guest can use multiple tx entries
114 VMNET_CAP_RX_CHAIN = 0x8000, /* pkt can span multiple rx entries */
115 VMNET_CAP_LPD = 0x10000, /* large pkt delivery */
116 VMNET_CAP_BPF = 0x20000, /* BPF Support in VMXNET Virtual HW*/
117 VMNET_CAP_SG_SPAN_PAGES = 0x40000, /* Scatter-gather can span multiple*/
118 /* pages transmits */
119 VMNET_CAP_IP6_CSUM = 0x80000, /* Can do IPv6 csum offload. */
120 VMNET_CAP_TSO6 = 0x100000, /* TSO seg. offload for IPv6 pkts. */
121 VMNET_CAP_TSO256k = 0x200000, /* Can do TSO seg offload for */
122 /* pkts up to 256kB. */
123 VMNET_CAP_UPT = 0x400000 /* Support UPT */
127 * Maximum devices supported.
129 #define MAX_ETHERNET_CARDS 10
130 #define MAX_PCI_PASSTHRU_DEVICE 6
132 struct vmxnet3_cmd_ring {
133 union Vmxnet3_GenericDesc *base;
142 vmxnet3_cmd_ring_adv_next2fill(struct vmxnet3_cmd_ring *ring)
145 if (unlikely(ring->next2fill == ring->size)) {
147 VMXNET3_FLIP_RING_GEN(ring->gen);
152 vmxnet3_cmd_ring_adv_next2comp(struct vmxnet3_cmd_ring *ring)
154 VMXNET3_INC_RING_IDX_ONLY(ring->next2comp, ring->size);
158 vmxnet3_cmd_ring_desc_avail(struct vmxnet3_cmd_ring *ring)
160 return (ring->next2comp > ring->next2fill ? 0 : ring->size) +
161 ring->next2comp - ring->next2fill - 1;
164 struct vmxnet3_comp_ring {
165 union Vmxnet3_GenericDesc *base;
174 vmxnet3_comp_ring_adv_next2proc(struct vmxnet3_comp_ring *ring)
177 if (unlikely(ring->next2proc == ring->size)) {
179 VMXNET3_FLIP_RING_GEN(ring->gen);
183 struct vmxnet3_tx_data_ring {
184 struct Vmxnet3_TxDataDesc *base;
189 enum vmxnet3_buf_map_type {
190 VMXNET3_MAP_INVALID = 0,
196 struct vmxnet3_tx_buf_info {
204 struct vmxnet3_tq_driver_stats {
205 u64 drop_total; /* # of pkts dropped by the driver, the
206 * counters below track droppings due to
209 u64 drop_too_many_frags;
210 u64 drop_oversized_hdr;
211 u64 drop_hdr_inspect_err;
215 u64 linearized; /* # of pkts linearized */
216 u64 copy_skb_header; /* # of times we have to copy skb header */
220 struct vmxnet3_tx_ctx {
224 u32 l4_offset; /* only valid for pkts requesting tso or csum
225 * offloading. For encap offload, it refers to
226 * inner L4 offset i.e. it includes outer header
227 * encap header and inner eth and ip header size
230 u32 l4_hdr_size; /* only valid if mss != 0
231 * Refers to inner L4 hdr size for encap
234 u32 copy_size; /* # of bytes copied into the data ring */
235 union Vmxnet3_GenericDesc *sop_txd;
236 union Vmxnet3_GenericDesc *eop_txd;
239 struct vmxnet3_tx_queue {
240 char name[IFNAMSIZ+8]; /* To identify interrupt */
241 struct vmxnet3_adapter *adapter;
243 struct vmxnet3_cmd_ring tx_ring;
244 struct vmxnet3_tx_buf_info *buf_info;
245 struct vmxnet3_tx_data_ring data_ring;
246 struct vmxnet3_comp_ring comp_ring;
247 struct Vmxnet3_TxQueueCtrl *shared;
248 struct vmxnet3_tq_driver_stats stats;
250 int num_stop; /* # of times the queue is
253 u16 txdata_desc_size;
254 } __attribute__((__aligned__(SMP_CACHE_BYTES)));
256 enum vmxnet3_rx_buf_type {
257 VMXNET3_RX_BUF_NONE = 0,
258 VMXNET3_RX_BUF_SKB = 1,
259 VMXNET3_RX_BUF_PAGE = 2
262 struct vmxnet3_rx_buf_info {
263 enum vmxnet3_rx_buf_type buf_type;
272 struct vmxnet3_rx_ctx {
277 struct vmxnet3_rq_driver_stats {
281 u64 rx_buf_alloc_failure;
284 struct vmxnet3_rx_data_ring {
285 Vmxnet3_RxDataDesc *base;
290 struct vmxnet3_rx_queue {
291 char name[IFNAMSIZ + 8]; /* To identify interrupt */
292 struct vmxnet3_adapter *adapter;
293 struct napi_struct napi;
294 struct vmxnet3_cmd_ring rx_ring[2];
295 struct vmxnet3_rx_data_ring data_ring;
296 struct vmxnet3_comp_ring comp_ring;
297 struct vmxnet3_rx_ctx rx_ctx;
298 u32 qid; /* rqID in RCD for buffer from 1st ring */
299 u32 qid2; /* rqID in RCD for buffer from 2nd ring */
300 u32 dataRingQid; /* rqID in RCD for buffer from data ring */
301 struct vmxnet3_rx_buf_info *buf_info[2];
302 struct Vmxnet3_RxQueueCtrl *shared;
303 struct vmxnet3_rq_driver_stats stats;
304 } __attribute__((__aligned__(SMP_CACHE_BYTES)));
306 #define VMXNET3_DEVICE_MAX_TX_QUEUES 32
307 #define VMXNET3_DEVICE_MAX_RX_QUEUES 32 /* Keep this value as a power of 2 */
309 #define VMXNET3_DEVICE_DEFAULT_TX_QUEUES 8
310 #define VMXNET3_DEVICE_DEFAULT_RX_QUEUES 8 /* Keep this value as a power of 2 */
312 /* Should be less than UPT1_RSS_MAX_IND_TABLE_SIZE */
313 #define VMXNET3_RSS_IND_TABLE_SIZE (VMXNET3_DEVICE_MAX_RX_QUEUES * 4)
315 #define VMXNET3_LINUX_MAX_MSIX_VECT (VMXNET3_DEVICE_MAX_TX_QUEUES + \
316 VMXNET3_DEVICE_MAX_RX_QUEUES + 1)
317 #define VMXNET3_LINUX_MIN_MSIX_VECT 3 /* 1 for tx, 1 for rx pair and 1 for event */
320 struct vmxnet3_intr {
321 enum vmxnet3_intr_mask_mode mask_mode;
322 enum vmxnet3_intr_type type; /* MSI-X, MSI, or INTx? */
323 u8 num_intrs; /* # of intr vectors */
324 u8 event_intr_idx; /* idx of the intr vector for event */
325 u8 mod_levels[VMXNET3_LINUX_MAX_MSIX_VECT]; /* moderation level */
326 char event_msi_vector_name[IFNAMSIZ+17];
327 #ifdef CONFIG_PCI_MSI
328 struct msix_entry msix_entries[VMXNET3_LINUX_MAX_MSIX_VECT];
332 /* Interrupt sharing schemes, share_intr */
333 #define VMXNET3_INTR_BUDDYSHARE 0 /* Corresponding tx,rx queues share irq */
334 #define VMXNET3_INTR_TXSHARE 1 /* All tx queues share one irq */
335 #define VMXNET3_INTR_DONTSHARE 2 /* each queue has its own irq */
338 #define VMXNET3_STATE_BIT_RESETTING 0
339 #define VMXNET3_STATE_BIT_QUIESCED 1
340 struct vmxnet3_adapter {
341 struct vmxnet3_tx_queue tx_queue[VMXNET3_DEVICE_MAX_TX_QUEUES];
342 struct vmxnet3_rx_queue rx_queue[VMXNET3_DEVICE_MAX_RX_QUEUES];
343 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
344 struct vmxnet3_intr intr;
346 struct Vmxnet3_DriverShared *shared;
347 struct Vmxnet3_PMConf *pm_conf;
348 struct Vmxnet3_TxQueueDesc *tqd_start; /* all tx queue desc */
349 struct Vmxnet3_RxQueueDesc *rqd_start; /* all rx queue desc */
350 struct net_device *netdev;
351 struct pci_dev *pdev;
353 u8 __iomem *hw_addr0; /* for BAR 0 */
354 u8 __iomem *hw_addr1; /* for BAR 1 */
358 struct UPT1_RSSConf *rss_conf;
364 /* rx buffer related */
365 unsigned skb_buf_size;
366 int rx_buf_per_pkt; /* only apply to the 1st ring */
367 dma_addr_t shared_pa;
368 dma_addr_t queue_desc_pa;
369 dma_addr_t coal_conf_pa;
375 u32 link_speed; /* in mbps */
377 u64 tx_timeout_count;
384 /* Size of buffer in the data ring */
385 u16 txdata_desc_size;
386 u16 rxdata_desc_size;
388 bool rxdataring_enabled;
389 bool default_rss_fields;
390 enum Vmxnet3_RSSField rss_fields;
392 struct work_struct work;
394 unsigned long state; /* VMXNET3_STATE_BIT_xxx */
398 struct Vmxnet3_CoalesceScheme *coal_conf;
399 bool default_coal_mode;
401 dma_addr_t adapter_pa;
402 dma_addr_t pm_conf_pa;
403 dma_addr_t rss_conf_pa;
404 bool queuesExtEnabled;
407 #define VMXNET3_WRITE_BAR0_REG(adapter, reg, val) \
408 writel((val), (adapter)->hw_addr0 + (reg))
409 #define VMXNET3_READ_BAR0_REG(adapter, reg) \
410 readl((adapter)->hw_addr0 + (reg))
412 #define VMXNET3_WRITE_BAR1_REG(adapter, reg, val) \
413 writel((val), (adapter)->hw_addr1 + (reg))
414 #define VMXNET3_READ_BAR1_REG(adapter, reg) \
415 readl((adapter)->hw_addr1 + (reg))
417 #define VMXNET3_WAKE_QUEUE_THRESHOLD(tq) (5)
418 #define VMXNET3_RX_ALLOC_THRESHOLD(rq, ring_idx, adapter) \
419 ((rq)->rx_ring[ring_idx].size >> 3)
421 #define VMXNET3_GET_ADDR_LO(dma) ((u32)(dma))
422 #define VMXNET3_GET_ADDR_HI(dma) ((u32)(((u64)(dma)) >> 32))
424 #define VMXNET3_VERSION_GE_2(adapter) \
425 (adapter->version >= VMXNET3_REV_2 + 1)
426 #define VMXNET3_VERSION_GE_3(adapter) \
427 (adapter->version >= VMXNET3_REV_3 + 1)
428 #define VMXNET3_VERSION_GE_4(adapter) \
429 (adapter->version >= VMXNET3_REV_4 + 1)
430 #define VMXNET3_VERSION_GE_5(adapter) \
431 (adapter->version >= VMXNET3_REV_5 + 1)
432 #define VMXNET3_VERSION_GE_6(adapter) \
433 (adapter->version >= VMXNET3_REV_6 + 1)
435 /* must be a multiple of VMXNET3_RING_SIZE_ALIGN */
436 #define VMXNET3_DEF_TX_RING_SIZE 512
437 #define VMXNET3_DEF_RX_RING_SIZE 1024
438 #define VMXNET3_DEF_RX_RING2_SIZE 256
440 #define VMXNET3_DEF_RXDATA_DESC_SIZE 128
442 #define VMXNET3_MAX_ETH_HDR_SIZE 22
443 #define VMXNET3_MAX_SKB_BUF_SIZE (3*1024)
445 #define VMXNET3_GET_RING_IDX(adapter, rqID) \
446 ((rqID >= adapter->num_rx_queues && \
447 rqID < 2 * adapter->num_rx_queues) ? 1 : 0) \
449 #define VMXNET3_RX_DATA_RING(adapter, rqID) \
450 (rqID >= 2 * adapter->num_rx_queues && \
451 rqID < 3 * adapter->num_rx_queues) \
453 #define VMXNET3_COAL_STATIC_DEFAULT_DEPTH 64
455 #define VMXNET3_COAL_RBC_RATE(usecs) (1000000 / usecs)
456 #define VMXNET3_COAL_RBC_USECS(rbc_rate) (1000000 / rbc_rate)
457 #define VMXNET3_RSS_FIELDS_DEFAULT (VMXNET3_RSS_FIELDS_TCPIP4 | \
458 VMXNET3_RSS_FIELDS_TCPIP6)
461 vmxnet3_quiesce_dev(struct vmxnet3_adapter *adapter);
464 vmxnet3_activate_dev(struct vmxnet3_adapter *adapter);
467 vmxnet3_force_close(struct vmxnet3_adapter *adapter);
470 vmxnet3_reset_dev(struct vmxnet3_adapter *adapter);
473 vmxnet3_tq_destroy_all(struct vmxnet3_adapter *adapter);
476 vmxnet3_rq_destroy_all(struct vmxnet3_adapter *adapter);
479 vmxnet3_fix_features(struct net_device *netdev, netdev_features_t features);
482 vmxnet3_features_check(struct sk_buff *skb,
483 struct net_device *netdev, netdev_features_t features);
486 vmxnet3_set_features(struct net_device *netdev, netdev_features_t features);
489 vmxnet3_create_queues(struct vmxnet3_adapter *adapter,
490 u32 tx_ring_size, u32 rx_ring_size, u32 rx_ring2_size,
491 u16 txdata_desc_size, u16 rxdata_desc_size);
493 void vmxnet3_set_ethtool_ops(struct net_device *netdev);
495 void vmxnet3_get_stats64(struct net_device *dev,
496 struct rtnl_link_stats64 *stats);
498 extern char vmxnet3_driver_name[];