[mirror_ubuntu-hirsute-kernel.git] / drivers / net / vmxnet3 / vmxnet3_int.h

/*
 * Linux driver for VMware's vmxnet3 ethernet NIC.
 *
 * Copyright (C) 2008-2020, VMware, Inc. All Rights Reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; version 2 of the License and no later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
 * NON INFRINGEMENT.  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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * The full GNU General Public License is included in this distribution in
 * the file called "COPYING".
 *
 * Maintained by: pv-drivers@vmware.com
 *
 */

#ifndef _VMXNET3_INT_H
#define _VMXNET3_INT_H

#include <linux/bitops.h>
#include <linux/ethtool.h>
#include <linux/delay.h>
#include <linux/netdevice.h>
#include <linux/pci.h>
#include <linux/compiler.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/ioport.h>
#include <linux/highmem.h>
#include <linux/timer.h>
#include <linux/skbuff.h>
#include <linux/interrupt.h>
#include <linux/workqueue.h>
#include <linux/uaccess.h>
#include <asm/dma.h>
#include <asm/page.h>

#include <linux/tcp.h>
#include <linux/udp.h>
#include <linux/ip.h>
#include <linux/ipv6.h>
#include <linux/in.h>
#include <linux/etherdevice.h>
#include <asm/checksum.h>
#include <linux/if_vlan.h>
#include <linux/if_arp.h>
#include <linux/inetdevice.h>
#include <linux/log2.h>

#include "vmxnet3_defs.h"

#ifdef DEBUG
# define VMXNET3_DRIVER_VERSION_REPORT VMXNET3_DRIVER_VERSION_STRING"-NAPI(debug)"
#else
# define VMXNET3_DRIVER_VERSION_REPORT VMXNET3_DRIVER_VERSION_STRING"-NAPI"
#endif


/*
 * Version numbers
 */
#define VMXNET3_DRIVER_VERSION_STRING   "1.4.17.0-k"

/* Each byte of this 32-bit integer encodes a version number in
 * VMXNET3_DRIVER_VERSION_STRING.
 */
#define VMXNET3_DRIVER_VERSION_NUM      0x01041100

#if defined(CONFIG_PCI_MSI)
	/* RSS only makes sense if MSI-X is supported. */
	#define VMXNET3_RSS
#endif

#define VMXNET3_REV_4		3	/* Vmxnet3 Rev. 4 */
#define VMXNET3_REV_3		2	/* Vmxnet3 Rev. 3 */
#define VMXNET3_REV_2		1	/* Vmxnet3 Rev. 2 */
#define VMXNET3_REV_1		0	/* Vmxnet3 Rev. 1 */

/*
 * Capabilities
 */

enum {
	VMNET_CAP_SG	        = 0x0001, /* Can do scatter-gather transmits. */
	VMNET_CAP_IP4_CSUM      = 0x0002, /* Can checksum only TCP/UDP over
					   * IPv4 */
	VMNET_CAP_HW_CSUM       = 0x0004, /* Can checksum all packets. */
	VMNET_CAP_HIGH_DMA      = 0x0008, /* Can DMA to high memory. */
	VMNET_CAP_TOE	        = 0x0010, /* Supports TCP/IP offload. */
	VMNET_CAP_TSO	        = 0x0020, /* Supports TCP Segmentation
					   * offload */
	VMNET_CAP_SW_TSO        = 0x0040, /* Supports SW TCP Segmentation */
	VMNET_CAP_VMXNET_APROM  = 0x0080, /* Vmxnet APROM support */
	VMNET_CAP_HW_TX_VLAN    = 0x0100, /* Can we do VLAN tagging in HW */
	VMNET_CAP_HW_RX_VLAN    = 0x0200, /* Can we do VLAN untagging in HW */
	VMNET_CAP_SW_VLAN       = 0x0400, /* VLAN tagging/untagging in SW */
	VMNET_CAP_WAKE_PCKT_RCV = 0x0800, /* Can wake on network packet recv? */
	VMNET_CAP_ENABLE_INT_INLINE = 0x1000,  /* Enable Interrupt Inline */
	VMNET_CAP_ENABLE_HEADER_COPY = 0x2000,  /* copy header for vmkernel */
	VMNET_CAP_TX_CHAIN      = 0x4000, /* Guest can use multiple tx entries
					  * for a pkt */
	VMNET_CAP_RX_CHAIN      = 0x8000, /* pkt can span multiple rx entries */
	VMNET_CAP_LPD           = 0x10000, /* large pkt delivery */
	VMNET_CAP_BPF           = 0x20000, /* BPF Support in VMXNET Virtual HW*/
	VMNET_CAP_SG_SPAN_PAGES = 0x40000, /* Scatter-gather can span multiple*/
					   /* pages transmits */
	VMNET_CAP_IP6_CSUM      = 0x80000, /* Can do IPv6 csum offload. */
	VMNET_CAP_TSO6         = 0x100000, /* TSO seg. offload for IPv6 pkts. */
	VMNET_CAP_TSO256k      = 0x200000, /* Can do TSO seg offload for */
					   /* pkts up to 256kB. */
	VMNET_CAP_UPT          = 0x400000  /* Support UPT */
};

/*
 * Maximum devices supported.
 */
#define MAX_ETHERNET_CARDS		10
#define MAX_PCI_PASSTHRU_DEVICE		6

struct vmxnet3_cmd_ring {
	union Vmxnet3_GenericDesc *base;
	u32		size;
	u32		next2fill;
	u32		next2comp;
	u8		gen;
	dma_addr_t	basePA;
};

static inline void
vmxnet3_cmd_ring_adv_next2fill(struct vmxnet3_cmd_ring *ring)
{
	ring->next2fill++;
	if (unlikely(ring->next2fill == ring->size)) {
		ring->next2fill = 0;
		VMXNET3_FLIP_RING_GEN(ring->gen);
	}
}

static inline void
vmxnet3_cmd_ring_adv_next2comp(struct vmxnet3_cmd_ring *ring)
{
	VMXNET3_INC_RING_IDX_ONLY(ring->next2comp, ring->size);
}

static inline int
vmxnet3_cmd_ring_desc_avail(struct vmxnet3_cmd_ring *ring)
{
	return (ring->next2comp > ring->next2fill ? 0 : ring->size) +
		ring->next2comp - ring->next2fill - 1;
}

struct vmxnet3_comp_ring {
	union Vmxnet3_GenericDesc *base;
	u32               size;
	u32               next2proc;
	u8                gen;
	u8                intr_idx;
	dma_addr_t           basePA;
};

static inline void
vmxnet3_comp_ring_adv_next2proc(struct vmxnet3_comp_ring *ring)
{
	ring->next2proc++;
	if (unlikely(ring->next2proc == ring->size)) {
		ring->next2proc = 0;
		VMXNET3_FLIP_RING_GEN(ring->gen);
	}
}

struct vmxnet3_tx_data_ring {
	struct Vmxnet3_TxDataDesc *base;
	u32              size;
	dma_addr_t          basePA;
};

enum vmxnet3_buf_map_type {
	VMXNET3_MAP_INVALID = 0,
	VMXNET3_MAP_NONE,
	VMXNET3_MAP_SINGLE,
	VMXNET3_MAP_PAGE,
};

struct vmxnet3_tx_buf_info {
	u32      map_type;
	u16      len;
	u16      sop_idx;
	dma_addr_t  dma_addr;
	struct sk_buff *skb;
};

struct vmxnet3_tq_driver_stats {
	u64 drop_total;     /* # of pkts dropped by the driver, the
				* counters below track droppings due to
				* different reasons
				*/
	u64 drop_too_many_frags;
	u64 drop_oversized_hdr;
	u64 drop_hdr_inspect_err;
	u64 drop_tso;

	u64 tx_ring_full;
	u64 linearized;         /* # of pkts linearized */
	u64 copy_skb_header;    /* # of times we have to copy skb header */
	u64 oversized_hdr;
};

struct vmxnet3_tx_ctx {
	bool   ipv4;
	bool   ipv6;
	u16 mss;
	u32 eth_ip_hdr_size; /* only valid for pkts requesting tso or csum
				 * offloading
				 */
	u32 l4_hdr_size;     /* only valid if mss != 0 */
	u32 copy_size;       /* # of bytes copied into the data ring */
	union Vmxnet3_GenericDesc *sop_txd;
	union Vmxnet3_GenericDesc *eop_txd;
};

struct vmxnet3_tx_queue {
	char			name[IFNAMSIZ+8]; /* To identify interrupt */
	struct vmxnet3_adapter		*adapter;
	spinlock_t                      tx_lock;
	struct vmxnet3_cmd_ring         tx_ring;
	struct vmxnet3_tx_buf_info      *buf_info;
	dma_addr_t                       buf_info_pa;
	struct vmxnet3_tx_data_ring     data_ring;
	struct vmxnet3_comp_ring        comp_ring;
	struct Vmxnet3_TxQueueCtrl      *shared;
	struct vmxnet3_tq_driver_stats  stats;
	bool                            stopped;
	int                             num_stop;  /* # of times the queue is
						    * stopped */
	int				qid;
	u16				txdata_desc_size;
} __attribute__((__aligned__(SMP_CACHE_BYTES)));

enum vmxnet3_rx_buf_type {
	VMXNET3_RX_BUF_NONE = 0,
	VMXNET3_RX_BUF_SKB = 1,
	VMXNET3_RX_BUF_PAGE = 2
};

struct vmxnet3_rx_buf_info {
	enum vmxnet3_rx_buf_type buf_type;
	u16     len;
	union {
		struct sk_buff *skb;
		struct page    *page;
	};
	dma_addr_t dma_addr;
};

struct vmxnet3_rx_ctx {
	struct sk_buff *skb;
	u32 sop_idx;
};

struct vmxnet3_rq_driver_stats {
	u64 drop_total;
	u64 drop_err;
	u64 drop_fcs;
	u64 rx_buf_alloc_failure;
};

struct vmxnet3_rx_data_ring {
	Vmxnet3_RxDataDesc *base;
	dma_addr_t basePA;
	u16 desc_size;
};

struct vmxnet3_rx_queue {
	char			name[IFNAMSIZ + 8]; /* To identify interrupt */
	struct vmxnet3_adapter	  *adapter;
	struct napi_struct        napi;
	struct vmxnet3_cmd_ring   rx_ring[2];
	struct vmxnet3_rx_data_ring data_ring;
	struct vmxnet3_comp_ring  comp_ring;
	struct vmxnet3_rx_ctx     rx_ctx;
	u32 qid;            /* rqID in RCD for buffer from 1st ring */
	u32 qid2;           /* rqID in RCD for buffer from 2nd ring */
	u32 dataRingQid;    /* rqID in RCD for buffer from data ring */
	struct vmxnet3_rx_buf_info     *buf_info[2];
	dma_addr_t                      buf_info_pa;
	struct Vmxnet3_RxQueueCtrl            *shared;
	struct vmxnet3_rq_driver_stats  stats;
} __attribute__((__aligned__(SMP_CACHE_BYTES)));

#define VMXNET3_DEVICE_MAX_TX_QUEUES 8
#define VMXNET3_DEVICE_MAX_RX_QUEUES 8   /* Keep this value as a power of 2 */

/* Should be less than UPT1_RSS_MAX_IND_TABLE_SIZE */
#define VMXNET3_RSS_IND_TABLE_SIZE (VMXNET3_DEVICE_MAX_RX_QUEUES * 4)

#define VMXNET3_LINUX_MAX_MSIX_VECT     (VMXNET3_DEVICE_MAX_TX_QUEUES + \
					 VMXNET3_DEVICE_MAX_RX_QUEUES + 1)
#define VMXNET3_LINUX_MIN_MSIX_VECT     2 /* 1 for tx-rx pair and 1 for event */


struct vmxnet3_intr {
	enum vmxnet3_intr_mask_mode  mask_mode;
	enum vmxnet3_intr_type       type;	/* MSI-X, MSI, or INTx? */
	u8  num_intrs;			/* # of intr vectors */
	u8  event_intr_idx;		/* idx of the intr vector for event */
	u8  mod_levels[VMXNET3_LINUX_MAX_MSIX_VECT]; /* moderation level */
	char	event_msi_vector_name[IFNAMSIZ+17];
#ifdef CONFIG_PCI_MSI
	struct msix_entry msix_entries[VMXNET3_LINUX_MAX_MSIX_VECT];
#endif
};

/* Interrupt sharing schemes, share_intr */
#define VMXNET3_INTR_BUDDYSHARE 0    /* Corresponding tx,rx queues share irq */
#define VMXNET3_INTR_TXSHARE 1	     /* All tx queues share one irq */
#define VMXNET3_INTR_DONTSHARE 2     /* each queue has its own irq */


#define VMXNET3_STATE_BIT_RESETTING   0
#define VMXNET3_STATE_BIT_QUIESCED    1
struct vmxnet3_adapter {
	struct vmxnet3_tx_queue		tx_queue[VMXNET3_DEVICE_MAX_TX_QUEUES];
	struct vmxnet3_rx_queue		rx_queue[VMXNET3_DEVICE_MAX_RX_QUEUES];
	unsigned long			active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
	struct vmxnet3_intr		intr;
	spinlock_t			cmd_lock;
	struct Vmxnet3_DriverShared	*shared;
	struct Vmxnet3_PMConf		*pm_conf;
	struct Vmxnet3_TxQueueDesc	*tqd_start;     /* all tx queue desc */
	struct Vmxnet3_RxQueueDesc	*rqd_start;	/* all rx queue desc */
	struct net_device		*netdev;
	struct pci_dev			*pdev;

	u8			__iomem *hw_addr0; /* for BAR 0 */
	u8			__iomem *hw_addr1; /* for BAR 1 */
	u8                              version;

#ifdef VMXNET3_RSS
	struct UPT1_RSSConf		*rss_conf;
	bool				rss;
#endif
	u32				num_rx_queues;
	u32				num_tx_queues;

	/* rx buffer related */
	unsigned			skb_buf_size;
	int		rx_buf_per_pkt;  /* only apply to the 1st ring */
	dma_addr_t			shared_pa;
	dma_addr_t queue_desc_pa;
	dma_addr_t coal_conf_pa;

	/* Wake-on-LAN */
	u32     wol;

	/* Link speed */
	u32     link_speed; /* in mbps */

	u64     tx_timeout_count;

	/* Ring sizes */
	u32 tx_ring_size;
	u32 rx_ring_size;
	u32 rx_ring2_size;

	/* Size of buffer in the data ring */
	u16 txdata_desc_size;
	u16 rxdata_desc_size;

	bool rxdataring_enabled;

	struct work_struct work;

	unsigned long  state;    /* VMXNET3_STATE_BIT_xxx */

	int share_intr;

	struct Vmxnet3_CoalesceScheme *coal_conf;
	bool   default_coal_mode;

	dma_addr_t adapter_pa;
	dma_addr_t pm_conf_pa;
	dma_addr_t rss_conf_pa;
};

#define VMXNET3_WRITE_BAR0_REG(adapter, reg, val)  \
	writel((val), (adapter)->hw_addr0 + (reg))
#define VMXNET3_READ_BAR0_REG(adapter, reg)        \
	readl((adapter)->hw_addr0 + (reg))

#define VMXNET3_WRITE_BAR1_REG(adapter, reg, val)  \
	writel((val), (adapter)->hw_addr1 + (reg))
#define VMXNET3_READ_BAR1_REG(adapter, reg)        \
	readl((adapter)->hw_addr1 + (reg))

#define VMXNET3_WAKE_QUEUE_THRESHOLD(tq)  (5)
#define VMXNET3_RX_ALLOC_THRESHOLD(rq, ring_idx, adapter) \
	((rq)->rx_ring[ring_idx].size >> 3)

#define VMXNET3_GET_ADDR_LO(dma)   ((u32)(dma))
#define VMXNET3_GET_ADDR_HI(dma)   ((u32)(((u64)(dma)) >> 32))

#define VMXNET3_VERSION_GE_2(adapter) \
	(adapter->version >= VMXNET3_REV_2 + 1)
#define VMXNET3_VERSION_GE_3(adapter) \
	(adapter->version >= VMXNET3_REV_3 + 1)
#define VMXNET3_VERSION_GE_4(adapter) \
	(adapter->version >= VMXNET3_REV_4 + 1)

/* must be a multiple of VMXNET3_RING_SIZE_ALIGN */
#define VMXNET3_DEF_TX_RING_SIZE    512
#define VMXNET3_DEF_RX_RING_SIZE    1024
#define VMXNET3_DEF_RX_RING2_SIZE   256

#define VMXNET3_DEF_RXDATA_DESC_SIZE 128

#define VMXNET3_MAX_ETH_HDR_SIZE    22
#define VMXNET3_MAX_SKB_BUF_SIZE    (3*1024)

#define VMXNET3_GET_RING_IDX(adapter, rqID)		\
	((rqID >= adapter->num_rx_queues &&		\
	 rqID < 2 * adapter->num_rx_queues) ? 1 : 0)	\

#define VMXNET3_RX_DATA_RING(adapter, rqID)		\
	(rqID >= 2 * adapter->num_rx_queues &&		\
	rqID < 3 * adapter->num_rx_queues)		\

#define VMXNET3_COAL_STATIC_DEFAULT_DEPTH	64

#define VMXNET3_COAL_RBC_RATE(usecs) (1000000 / usecs)
#define VMXNET3_COAL_RBC_USECS(rbc_rate) (1000000 / rbc_rate)

int
vmxnet3_quiesce_dev(struct vmxnet3_adapter *adapter);

int
vmxnet3_activate_dev(struct vmxnet3_adapter *adapter);

void
vmxnet3_force_close(struct vmxnet3_adapter *adapter);

void
vmxnet3_reset_dev(struct vmxnet3_adapter *adapter);

void
vmxnet3_tq_destroy_all(struct vmxnet3_adapter *adapter);

void
vmxnet3_rq_destroy_all(struct vmxnet3_adapter *adapter);

netdev_features_t
vmxnet3_fix_features(struct net_device *netdev, netdev_features_t features);

int
vmxnet3_set_features(struct net_device *netdev, netdev_features_t features);

int
vmxnet3_create_queues(struct vmxnet3_adapter *adapter,
		      u32 tx_ring_size, u32 rx_ring_size, u32 rx_ring2_size,
		      u16 txdata_desc_size, u16 rxdata_desc_size);

void vmxnet3_set_ethtool_ops(struct net_device *netdev);

void vmxnet3_get_stats64(struct net_device *dev,
			 struct rtnl_link_stats64 *stats);

extern char vmxnet3_driver_name[];
#endif
Commit	Line	Data
d1a890fa SB	1	/*
	2	* Linux driver for VMware's vmxnet3 ethernet NIC.
	3	*
123db31d	4	* Copyright (C) 2008-2020, 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	*/
3dd7400b	72	#define VMXNET3_DRIVER_VERSION_STRING "1.4.17.0-k"
d1a890fa	73
61aeecea	74	/* Each byte of this 32-bit integer encodes a version number in
	75	* VMXNET3_DRIVER_VERSION_STRING.
	76	*/
3dd7400b	77	#define VMXNET3_DRIVER_VERSION_NUM 0x01041100
d1a890fa	78
09c5088e SB	79	#if defined(CONFIG_PCI_MSI)
	80	/* RSS only makes sense if MSI-X is supported. */
	81	#define VMXNET3_RSS
	82	#endif
d1a890fa	83
123db31d	84	#define VMXNET3_REV_4 3 /* Vmxnet3 Rev. 4 */
190af10f SK	85	#define VMXNET3_REV_3 2 /* Vmxnet3 Rev. 3 */
	86	#define VMXNET3_REV_2 1 /* Vmxnet3 Rev. 2 */
	87	#define VMXNET3_REV_1 0 /* Vmxnet3 Rev. 1 */
	88
d1a890fa SB	89	/*
	90	* Capabilities
	91	*/
	92
	93	enum {
	94	VMNET_CAP_SG = 0x0001, /* Can do scatter-gather transmits. */
	95	VMNET_CAP_IP4_CSUM = 0x0002, /* Can checksum only TCP/UDP over
	96	* IPv4 */
	97	VMNET_CAP_HW_CSUM = 0x0004, /* Can checksum all packets. */
	98	VMNET_CAP_HIGH_DMA = 0x0008, /* Can DMA to high memory. */
	99	VMNET_CAP_TOE = 0x0010, /* Supports TCP/IP offload. */
	100	VMNET_CAP_TSO = 0x0020, /* Supports TCP Segmentation
	101	* offload */
	102	VMNET_CAP_SW_TSO = 0x0040, /* Supports SW TCP Segmentation */
	103	VMNET_CAP_VMXNET_APROM = 0x0080, /* Vmxnet APROM support */
	104	VMNET_CAP_HW_TX_VLAN = 0x0100, /* Can we do VLAN tagging in HW */
	105	VMNET_CAP_HW_RX_VLAN = 0x0200, /* Can we do VLAN untagging in HW */
	106	VMNET_CAP_SW_VLAN = 0x0400, /* VLAN tagging/untagging in SW */
	107	VMNET_CAP_WAKE_PCKT_RCV = 0x0800, /* Can wake on network packet recv? */
	108	VMNET_CAP_ENABLE_INT_INLINE = 0x1000, /* Enable Interrupt Inline */
	109	VMNET_CAP_ENABLE_HEADER_COPY = 0x2000, /* copy header for vmkernel */
	110	VMNET_CAP_TX_CHAIN = 0x4000, /* Guest can use multiple tx entries
	111	* for a pkt */
	112	VMNET_CAP_RX_CHAIN = 0x8000, /* pkt can span multiple rx entries */
	113	VMNET_CAP_LPD = 0x10000, /* large pkt delivery */
	114	VMNET_CAP_BPF = 0x20000, /* BPF Support in VMXNET Virtual HW*/
	115	VMNET_CAP_SG_SPAN_PAGES = 0x40000, /* Scatter-gather can span multiple*/
	116	/* pages transmits */
	117	VMNET_CAP_IP6_CSUM = 0x80000, /* Can do IPv6 csum offload. */
	118	VMNET_CAP_TSO6 = 0x100000, /* TSO seg. offload for IPv6 pkts. */
	119	VMNET_CAP_TSO256k = 0x200000, /* Can do TSO seg offload for */
	120	/* pkts up to 256kB. */
	121	VMNET_CAP_UPT = 0x400000 /* Support UPT */
	122	};
	123
	124	/*
b1226c7d	125	* Maximum devices supported.
d1a890fa	126	*/
d1a890fa SB	127	#define MAX_ETHERNET_CARDS 10
	128	#define MAX_PCI_PASSTHRU_DEVICE 6
	129
	130	struct vmxnet3_cmd_ring {
	131	union Vmxnet3_GenericDesc *base;
	132	u32 size;
	133	u32 next2fill;
	134	u32 next2comp;
	135	u8 gen;
	136	dma_addr_t basePA;
	137	};
	138
	139	static inline void
	140	vmxnet3_cmd_ring_adv_next2fill(struct vmxnet3_cmd_ring *ring)
	141	{
	142	ring->next2fill++;
	143	if (unlikely(ring->next2fill == ring->size)) {
	144	ring->next2fill = 0;
	145	VMXNET3_FLIP_RING_GEN(ring->gen);
	146	}
	147	}
	148
	149	static inline void
	150	vmxnet3_cmd_ring_adv_next2comp(struct vmxnet3_cmd_ring *ring)
	151	{
	152	VMXNET3_INC_RING_IDX_ONLY(ring->next2comp, ring->size);
	153	}
	154
	155	static inline int
	156	vmxnet3_cmd_ring_desc_avail(struct vmxnet3_cmd_ring *ring)
	157	{
	158	return (ring->next2comp > ring->next2fill ? 0 : ring->size) +
	159	ring->next2comp - ring->next2fill - 1;
	160	}
	161
	162	struct vmxnet3_comp_ring {
	163	union Vmxnet3_GenericDesc *base;
	164	u32 size;
	165	u32 next2proc;
	166	u8 gen;
	167	u8 intr_idx;
	168	dma_addr_t basePA;
	169	};
	170
	171	static inline void
	172	vmxnet3_comp_ring_adv_next2proc(struct vmxnet3_comp_ring *ring)
	173	{
	174	ring->next2proc++;
	175	if (unlikely(ring->next2proc == ring->size)) {
	176	ring->next2proc = 0;
	177	VMXNET3_FLIP_RING_GEN(ring->gen);
	178	}
	179	}
	180
	181	struct vmxnet3_tx_data_ring {
	182	struct Vmxnet3_TxDataDesc *base;
	183	u32 size;
	184	dma_addr_t basePA;
	185	};
	186
	187	enum vmxnet3_buf_map_type {
	188	VMXNET3_MAP_INVALID = 0,
	189	VMXNET3_MAP_NONE,
	190	VMXNET3_MAP_SINGLE,
191	VMXNET3_MAP_PAGE,
192	};
193
194	struct vmxnet3_tx_buf_info {
195	u32 map_type;
196	u16 len;
197	u16 sop_idx;
198	dma_addr_t dma_addr;
199	struct sk_buff *skb;
200	};
201
202	struct vmxnet3_tq_driver_stats {
203	u64 drop_total; /* # of pkts dropped by the driver, the
204	* counters below track droppings due to
205	* different reasons
206	*/
207	u64 drop_too_many_frags;
208	u64 drop_oversized_hdr;
209	u64 drop_hdr_inspect_err;
210	u64 drop_tso;
211
212	u64 tx_ring_full;
213	u64 linearized; /* # of pkts linearized */
214	u64 copy_skb_header; /* # of times we have to copy skb header */
215	u64 oversized_hdr;
216	};
217
218	struct vmxnet3_tx_ctx {
219	bool ipv4;
759c9359	220	bool ipv6;
d1a890fa SB	221	u16 mss;
	222	u32 eth_ip_hdr_size; /* only valid for pkts requesting tso or csum
	223	* offloading
	224	*/
	225	u32 l4_hdr_size; /* only valid if mss != 0 */
	226	u32 copy_size; /* # of bytes copied into the data ring */
	227	union Vmxnet3_GenericDesc *sop_txd;
	228	union Vmxnet3_GenericDesc *eop_txd;
	229	};
	230
	231	struct vmxnet3_tx_queue {
09c5088e SB	232	char name[IFNAMSIZ+8]; /* To identify interrupt */
09c5088e SB	233	struct vmxnet3_adapter *adapter;
d1a890fa SB	234	spinlock_t tx_lock;
d1a890fa SB	235	struct vmxnet3_cmd_ring tx_ring;
09c5088e	236	struct vmxnet3_tx_buf_info *buf_info;
b0eb57cb	237	dma_addr_t buf_info_pa;
d1a890fa SB	238	struct vmxnet3_tx_data_ring data_ring;
d1a890fa SB	239	struct vmxnet3_comp_ring comp_ring;
09c5088e	240	struct Vmxnet3_TxQueueCtrl *shared;
d1a890fa SB	241	struct vmxnet3_tq_driver_stats stats;
	242	bool stopped;
	243	int num_stop; /* # of times the queue is
	244	* stopped */
09c5088e	245	int qid;
3c8b3efc	246	u16 txdata_desc_size;
d1a890fa SB	247	} __attribute__((__aligned__(SMP_CACHE_BYTES)));
	248
	249	enum vmxnet3_rx_buf_type {
	250	VMXNET3_RX_BUF_NONE = 0,
	251	VMXNET3_RX_BUF_SKB = 1,
	252	VMXNET3_RX_BUF_PAGE = 2
	253	};
	254
	255	struct vmxnet3_rx_buf_info {
	256	enum vmxnet3_rx_buf_type buf_type;
	257	u16 len;
	258	union {
	259	struct sk_buff *skb;
	260	struct page *page;
	261	};
	262	dma_addr_t dma_addr;
	263	};
	264
	265	struct vmxnet3_rx_ctx {
	266	struct sk_buff *skb;
	267	u32 sop_idx;
	268	};
	269
	270	struct vmxnet3_rq_driver_stats {
	271	u64 drop_total;
	272	u64 drop_err;
	273	u64 drop_fcs;
	274	u64 rx_buf_alloc_failure;
	275	};
	276
50a5ce3e SK	277	struct vmxnet3_rx_data_ring {
	278	Vmxnet3_RxDataDesc *base;
	279	dma_addr_t basePA;
	280	u16 desc_size;
	281	};
	282
d1a890fa	283	struct vmxnet3_rx_queue {
09c5088e SB	284	char name[IFNAMSIZ + 8]; /* To identify interrupt */
	285	struct vmxnet3_adapter *adapter;
	286	struct napi_struct napi;
d1a890fa	287	struct vmxnet3_cmd_ring rx_ring[2];
50a5ce3e	288	struct vmxnet3_rx_data_ring data_ring;
d1a890fa SB	289	struct vmxnet3_comp_ring comp_ring;
	290	struct vmxnet3_rx_ctx rx_ctx;
	291	u32 qid; /* rqID in RCD for buffer from 1st ring */
	292	u32 qid2; /* rqID in RCD for buffer from 2nd ring */
50a5ce3e	293	u32 dataRingQid; /* rqID in RCD for buffer from data ring */
d1a890fa	294	struct vmxnet3_rx_buf_info *buf_info[2];
b0eb57cb	295	dma_addr_t buf_info_pa;
d1a890fa SB	296	struct Vmxnet3_RxQueueCtrl *shared;
	297	struct vmxnet3_rq_driver_stats stats;
	298	} __attribute__((__aligned__(SMP_CACHE_BYTES)));
	299
09c5088e SB	300	#define VMXNET3_DEVICE_MAX_TX_QUEUES 8
	301	#define VMXNET3_DEVICE_MAX_RX_QUEUES 8 /* Keep this value as a power of 2 */
	302
	303	/* Should be less than UPT1_RSS_MAX_IND_TABLE_SIZE */
	304	#define VMXNET3_RSS_IND_TABLE_SIZE (VMXNET3_DEVICE_MAX_RX_QUEUES * 4)
	305
	306	#define VMXNET3_LINUX_MAX_MSIX_VECT (VMXNET3_DEVICE_MAX_TX_QUEUES + \
	307	VMXNET3_DEVICE_MAX_RX_QUEUES + 1)
7e96fbf2	308	#define VMXNET3_LINUX_MIN_MSIX_VECT 2 /* 1 for tx-rx pair and 1 for event */
09c5088e	309
d1a890fa SB	310
	311	struct vmxnet3_intr {
	312	enum vmxnet3_intr_mask_mode mask_mode;
	313	enum vmxnet3_intr_type type; /* MSI-X, MSI, or INTx? */
	314	u8 num_intrs; /* # of intr vectors */
	315	u8 event_intr_idx; /* idx of the intr vector for event */
	316	u8 mod_levels[VMXNET3_LINUX_MAX_MSIX_VECT]; /* moderation level */
c7673e4d	317	char event_msi_vector_name[IFNAMSIZ+17];
d1a890fa SB	318	#ifdef CONFIG_PCI_MSI
	319	struct msix_entry msix_entries[VMXNET3_LINUX_MAX_MSIX_VECT];
	320	#endif
	321	};
	322
09c5088e SB	323	/* Interrupt sharing schemes, share_intr */
	324	#define VMXNET3_INTR_BUDDYSHARE 0 /* Corresponding tx,rx queues share irq */
	325	#define VMXNET3_INTR_TXSHARE 1 /* All tx queues share one irq */
	326	#define VMXNET3_INTR_DONTSHARE 2 /* each queue has its own irq */
	327
	328
d1a890fa SB	329	#define VMXNET3_STATE_BIT_RESETTING 0
	330	#define VMXNET3_STATE_BIT_QUIESCED 1
	331	struct vmxnet3_adapter {
09c5088e SB	332	struct vmxnet3_tx_queue tx_queue[VMXNET3_DEVICE_MAX_TX_QUEUES];
09c5088e SB	333	struct vmxnet3_rx_queue rx_queue[VMXNET3_DEVICE_MAX_RX_QUEUES];
72e85c45	334	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
09c5088e	335	struct vmxnet3_intr intr;
83d0feff	336	spinlock_t cmd_lock;
09c5088e SB	337	struct Vmxnet3_DriverShared *shared;
	338	struct Vmxnet3_PMConf *pm_conf;
	339	struct Vmxnet3_TxQueueDesc tqd_start; / all tx queue desc */
	340	struct Vmxnet3_RxQueueDesc rqd_start; / all rx queue desc */
	341	struct net_device *netdev;
09c5088e	342	struct pci_dev *pdev;
d1a890fa	343
81e8e560 HH	344	u8 __iomem hw_addr0; / for BAR 0 */
81e8e560 HH	345	u8 __iomem hw_addr1; / for BAR 1 */
45dac1d6 SB	346	u8 version;
45dac1d6 SB	347
09c5088e SB	348	#ifdef VMXNET3_RSS
	349	struct UPT1_RSSConf *rss_conf;
	350	bool rss;
	351	#endif
	352	u32 num_rx_queues;
	353	u32 num_tx_queues;
d1a890fa SB	354
	355	/* rx buffer related */
	356	unsigned skb_buf_size;
	357	int rx_buf_per_pkt; /* only apply to the 1st ring */
	358	dma_addr_t shared_pa;
	359	dma_addr_t queue_desc_pa;
4edef40e	360	dma_addr_t coal_conf_pa;
d1a890fa SB	361
	362	/* Wake-on-LAN */
	363	u32 wol;
	364
	365	/* Link speed */
	366	u32 link_speed; /* in mbps */
	367
	368	u64 tx_timeout_count;
f00e2b0a NH	369
	370	/* Ring sizes */
	371	u32 tx_ring_size;
	372	u32 rx_ring_size;
53831aa1	373	u32 rx_ring2_size;
f00e2b0a	374
3c8b3efc SK	375	/* Size of buffer in the data ring */
3c8b3efc SK	376	u16 txdata_desc_size;
50a5ce3e SK	377	u16 rxdata_desc_size;
	378
	379	bool rxdataring_enabled;
3c8b3efc	380
d1a890fa SB	381	struct work_struct work;
	382
	383	unsigned long state; /* VMXNET3_STATE_BIT_xxx */
	384
09c5088e	385	int share_intr;
b0eb57cb	386
4edef40e SK	387	struct Vmxnet3_CoalesceScheme *coal_conf;
	388	bool default_coal_mode;
	389
b0eb57cb AK	390	dma_addr_t adapter_pa;
	391	dma_addr_t pm_conf_pa;
	392	dma_addr_t rss_conf_pa;
d1a890fa SB	393	};
	394
	395	#define VMXNET3_WRITE_BAR0_REG(adapter, reg, val) \
b8744cab	396	writel((val), (adapter)->hw_addr0 + (reg))
d1a890fa	397	#define VMXNET3_READ_BAR0_REG(adapter, reg) \
b8744cab	398	readl((adapter)->hw_addr0 + (reg))
d1a890fa SB	399
d1a890fa SB	400	#define VMXNET3_WRITE_BAR1_REG(adapter, reg, val) \
b8744cab	401	writel((val), (adapter)->hw_addr1 + (reg))
d1a890fa	402	#define VMXNET3_READ_BAR1_REG(adapter, reg) \
b8744cab	403	readl((adapter)->hw_addr1 + (reg))
d1a890fa SB	404
	405	#define VMXNET3_WAKE_QUEUE_THRESHOLD(tq) (5)
	406	#define VMXNET3_RX_ALLOC_THRESHOLD(rq, ring_idx, adapter) \
	407	((rq)->rx_ring[ring_idx].size >> 3)
	408
	409	#define VMXNET3_GET_ADDR_LO(dma) ((u32)(dma))
	410	#define VMXNET3_GET_ADDR_HI(dma) ((u32)(((u64)(dma)) >> 32))
	411
190af10f SK	412	#define VMXNET3_VERSION_GE_2(adapter) \
	413	(adapter->version >= VMXNET3_REV_2 + 1)
	414	#define VMXNET3_VERSION_GE_3(adapter) \
	415	(adapter->version >= VMXNET3_REV_3 + 1)
123db31d RD	416	#define VMXNET3_VERSION_GE_4(adapter) \
123db31d RD	417	(adapter->version >= VMXNET3_REV_4 + 1)
190af10f	418
d1a890fa SB	419	/* must be a multiple of VMXNET3_RING_SIZE_ALIGN */
d1a890fa SB	420	#define VMXNET3_DEF_TX_RING_SIZE 512
7475908f SK	421	#define VMXNET3_DEF_RX_RING_SIZE 1024
7475908f SK	422	#define VMXNET3_DEF_RX_RING2_SIZE 256
d1a890fa	423
50a5ce3e SK	424	#define VMXNET3_DEF_RXDATA_DESC_SIZE 128
50a5ce3e SK	425
d1a890fa SB	426	#define VMXNET3_MAX_ETH_HDR_SIZE 22
	427	#define VMXNET3_MAX_SKB_BUF_SIZE (3*1024)
	428
50a5ce3e SK	429	#define VMXNET3_GET_RING_IDX(adapter, rqID) \
	430	((rqID >= adapter->num_rx_queues && \
	431	rqID < 2 * adapter->num_rx_queues) ? 1 : 0) \
	432
	433	#define VMXNET3_RX_DATA_RING(adapter, rqID) \
	434	(rqID >= 2 * adapter->num_rx_queues && \
	435	rqID < 3 * adapter->num_rx_queues) \
	436
4edef40e SK	437	#define VMXNET3_COAL_STATIC_DEFAULT_DEPTH 64
	438
	439	#define VMXNET3_COAL_RBC_RATE(usecs) (1000000 / usecs)
	440	#define VMXNET3_COAL_RBC_USECS(rbc_rate) (1000000 / rbc_rate)
	441
d1a890fa SB	442	int
	443	vmxnet3_quiesce_dev(struct vmxnet3_adapter *adapter);
	444
	445	int
	446	vmxnet3_activate_dev(struct vmxnet3_adapter *adapter);
	447
	448	void
	449	vmxnet3_force_close(struct vmxnet3_adapter *adapter);
	450
	451	void
	452	vmxnet3_reset_dev(struct vmxnet3_adapter *adapter);
	453
	454	void
09c5088e	455	vmxnet3_tq_destroy_all(struct vmxnet3_adapter *adapter);
d1a890fa SB	456
d1a890fa SB	457	void
09c5088e	458	vmxnet3_rq_destroy_all(struct vmxnet3_adapter *adapter);
d1a890fa	459
3dd7400b RD	460	netdev_features_t
	461	vmxnet3_fix_features(struct net_device *netdev, netdev_features_t features);
	462
a0d2730c	463	int
c8f44aff	464	vmxnet3_set_features(struct net_device *netdev, netdev_features_t features);
a0d2730c	465
d1a890fa SB	466	int
d1a890fa SB	467	vmxnet3_create_queues(struct vmxnet3_adapter *adapter,
3c8b3efc	468	u32 tx_ring_size, u32 rx_ring_size, u32 rx_ring2_size,
50a5ce3e	469	u16 txdata_desc_size, u16 rxdata_desc_size);
d1a890fa	470
d8dea1eb	471	void vmxnet3_set_ethtool_ops(struct net_device *netdev);
95305f6c	472
bc1f4470	473	void vmxnet3_get_stats64(struct net_device *dev,
bc1f4470	474	struct rtnl_link_stats64 *stats);
d1a890fa SB	475
	476	extern char vmxnet3_driver_name[];
	477	#endif